hel 0.1.1

HEL — Heuristic Expression Language: a deterministic, auditable expression language & parser, AST, builtin registry and evaluator.
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
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
//! Package system for HEL domain schemas
//!
//! This module implements a package-based schema system that allows domains
//! to define versioned schema packages with dependencies and imports.
//!
//! ## Architecture
//! - Packages are defined by `hel-package.toml` manifests
//! - Schemas can import other packages, creating namespaced types
//! - A PackageRegistry loads and resolves package dependencies
//! - Type names are qualified to avoid collisions (e.g., security-binary.Binary)
//!
//! ## Determinism
//! - All package loading uses stable ordering (BTreeMap)
//! - Dependency resolution is deterministic
//! - Error messages include package/file/line context

use serde::{Deserialize, Serialize};
use std::collections::BTreeMap;
use std::path::{Path, PathBuf};
use std::sync::Arc;

use super::{parse_schema, Schema, TypeDef};

// region:    --- Package Manifest

/// Package manifest (hel-package.toml)
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct PackageManifest {
	/// Package name (e.g., "security-binary")
	pub name: String,
	/// Semver version string
	pub version: String,
	/// List of schema files to load (in order) or glob pattern
	pub schemas: Vec<String>,
	/// Dependencies: package_name -> version_requirement
	#[serde(default)]
	pub dependencies: BTreeMap<String, String>,
	/// Optional built-ins namespace (defaults to package name)
	#[serde(default)]
	pub builtins_namespace: Option<String>,
}

impl PackageManifest {
	/// Parse manifest from TOML string
	pub fn from_toml(content: &str) -> Result<Self, PackageError> {
		toml::from_str(content).map_err(|e| PackageError::ManifestParse(e.to_string()))
	}

	/// Load manifest from file
	pub fn from_file(path: &Path) -> Result<Self, PackageError> {
		let content = std::fs::read_to_string(path).map_err(|e| {
			PackageError::Io(format!("Failed to read manifest at {}: {}", path.display(), e))
		})?;
		Self::from_toml(&content)
	}
}

// endregion: --- Package Manifest

// region:    --- Loaded Package

/// A loaded package with parsed schemas and metadata
#[derive(Debug, Clone)]
pub struct SchemaPackage {
	/// The manifest
	pub manifest: PackageManifest,
	/// Parsed schemas (combined)
	pub schema: Schema,
	/// Imports declared in schema files
	pub imports: Vec<String>,
	/// Package root directory
	pub root_path: PathBuf,
}

impl SchemaPackage {
	/// Load a package from a directory containing hel-package.toml
	pub fn from_directory(dir: &Path) -> Result<Self, PackageError> {
		let manifest_path = dir.join("hel-package.toml");
		let manifest = PackageManifest::from_file(&manifest_path)?;

		let mut combined_schema = Schema::new();
		let mut all_imports = Vec::new();

		// Load schema files
		for schema_file in &manifest.schemas {
			let schema_path = dir.join(schema_file);
			let content = std::fs::read_to_string(&schema_path).map_err(|e| {
				PackageError::Io(format!("Failed to read schema {}: {}", schema_path.display(), e))
			})?;

			// Parse imports from schema content (simple line-based for now)
			let imports = extract_imports(&content);
			all_imports.extend(imports);

			// Parse schema
			let parsed = parse_schema(&content).map_err(|e| {
				PackageError::SchemaParse {
					package: manifest.name.clone(),
					file: schema_file.clone(),
					error: e,
				}
			})?;

			// Merge types into combined schema
			for (name, typedef) in parsed.types {
				if combined_schema.types.contains_key(&name) {
					return Err(PackageError::DuplicateType {
						package: manifest.name.clone(),
						type_name: name.to_string(),
					});
				}
				combined_schema.types.insert(name, typedef);
			}
		}

		Ok(Self {
			manifest,
			schema: combined_schema,
			imports: all_imports,
			root_path: dir.to_path_buf(),
		})
	}

	/// Get the namespace for this package (package name by default)
	pub fn namespace(&self) -> &str {
		&self.manifest.name
	}

	/// Get built-ins namespace (manifest.builtins_namespace or package name)
	pub fn builtins_namespace(&self) -> String {
		self.manifest
			.builtins_namespace
			.clone()
			.unwrap_or_else(|| self.manifest.name.clone())
	}
}

// endregion: --- Loaded Package

// region:    --- Package Registry

/// Registry that manages loading and resolving packages
#[derive(Debug, Clone)]
pub struct PackageRegistry {
	/// Search paths for packages
	search_paths: Vec<PathBuf>,
	/// Loaded packages: name -> package
	packages: BTreeMap<String, SchemaPackage>,
}

impl PackageRegistry {
	/// Create a new empty registry
	pub fn new() -> Self {
		Self {
			search_paths: Vec::new(),
			packages: BTreeMap::new(),
		}
	}

	/// Add a search path for packages
	pub fn add_search_path(&mut self, path: PathBuf) {
		self.search_paths.push(path);
	}

	/// Load a package by name
	///
	/// Searches in all registered search paths for a directory matching the package name.
	/// Version requirements are not yet enforced (milestone 1).
	pub fn load_package(&mut self, name: &str) -> Result<&SchemaPackage, PackageError> {
		// Check if already loaded
		if self.packages.contains_key(name) {
			return Ok(&self.packages[name]);
		}

		// Search for package directory
		let mut package_dir = None;
		for search_path in &self.search_paths {
			let candidate = search_path.join(name);
			if candidate.is_dir() && candidate.join("hel-package.toml").exists() {
				package_dir = Some(candidate);
				break;
			}
		}

		let dir = package_dir.ok_or_else(|| PackageError::PackageNotFound {
			name: name.to_string(),
			search_paths: self.search_paths.clone(),
		})?;

		// Load the package
		let package = SchemaPackage::from_directory(&dir)?;

		// Verify name matches
		if package.manifest.name != name {
			return Err(PackageError::NameMismatch {
				expected: name.to_string(),
				found: package.manifest.name.clone(),
			});
		}

		self.packages.insert(name.to_string(), package);
		Ok(&self.packages[name])
	}

	/// Resolve all dependencies for a root package recursively
	///
	/// Returns packages in deterministic topological order (dependencies first)
	pub fn resolve_all(&mut self, root_package: &str) -> Result<Vec<String>, PackageError> {
		let mut resolved = Vec::new();
		let mut visiting = std::collections::HashSet::new();

		self.resolve_recursive(root_package, &mut resolved, &mut visiting)?;

		Ok(resolved)
	}

	fn resolve_recursive(
		&mut self,
		package_name: &str,
		resolved: &mut Vec<String>,
		visiting: &mut std::collections::HashSet<String>,
	) -> Result<(), PackageError> {
		// Cycle detection
		if visiting.contains(package_name) {
			return Err(PackageError::CircularDependency {
				package: package_name.to_string(),
			});
		}

		// Already resolved
		if resolved.contains(&package_name.to_string()) {
			return Ok(());
		}

		visiting.insert(package_name.to_string());

		// Load package
		let package = self.load_package(package_name)?.clone();

		// Resolve dependencies first
		let deps: Vec<_> = package.manifest.dependencies.keys().cloned().collect();
		for dep in deps {
			self.resolve_recursive(&dep, resolved, visiting)?;
		}

		visiting.remove(package_name);
		resolved.push(package_name.to_string());

		Ok(())
	}

	/// Get a loaded package by name
	pub fn get_package(&self, name: &str) -> Option<&SchemaPackage> {
		self.packages.get(name)
	}

	/// Build a merged type environment from resolved packages
	///
	/// Returns a map of qualified type names (package.Type) to TypeDef
	pub fn build_type_environment(&self, package_names: &[String]) -> Result<TypeEnvironment, PackageError> {
		let mut types = BTreeMap::new();

		for pkg_name in package_names {
			let package = self.packages.get(pkg_name).ok_or_else(|| PackageError::PackageNotFound {
				name: pkg_name.clone(),
				search_paths: self.search_paths.clone(),
			})?;

			for (type_name, typedef) in &package.schema.types {
				let qualified_name = format!("{}.{}", package.namespace(), type_name);
				let qualified_name: Arc<str> = qualified_name.into();

				if types.contains_key(&qualified_name) {
					return Err(PackageError::TypeCollision {
						type_name: qualified_name.to_string(),
					});
				}

				types.insert(qualified_name, typedef.clone());
			}
		}

		Ok(TypeEnvironment { types })
	}
}

impl Default for PackageRegistry {
	fn default() -> Self {
		Self::new()
	}
}

// endregion: --- Package Registry

// region:    --- Type Environment

/// Merged type environment from multiple packages
#[derive(Debug, Clone)]
pub struct TypeEnvironment {
	/// Qualified type name (package.Type) -> TypeDef
	pub types: BTreeMap<Arc<str>, TypeDef>,
}

impl TypeEnvironment {
	/// Lookup a type by qualified name
	pub fn get_type(&self, qualified_name: &str) -> Option<&TypeDef> {
		self.types.get(qualified_name)
	}

	/// Validate all type references in the environment
	pub fn validate(&self) -> Result<(), PackageError> {
		for (qualified_name, typedef) in &self.types {
			for field in &typedef.fields {
				self.validate_field_type(&field.field_type, qualified_name)?;
			}
		}
		Ok(())
	}

	fn validate_field_type(&self, field_type: &super::FieldType, context: &str) -> Result<(), PackageError> {
		match field_type {
			super::FieldType::TypeRef(name) => {
				// Type references should be qualified (package.Type)
				if !self.types.contains_key(name) {
					return Err(PackageError::UndefinedTypeReference {
						type_name: name.to_string(),
						context: context.to_string(),
					});
				}
				Ok(())
			}
			super::FieldType::List(inner) | super::FieldType::Map(inner) => self.validate_field_type(inner, context),
			_ => Ok(()),
		}
	}
}

// endregion: --- Type Environment

// region:    --- Error Types

/// Package-related errors
#[derive(Debug, Clone)]
pub enum PackageError {
	/// Manifest parsing error
	ManifestParse(String),
	/// Schema parsing error in a specific package/file
	SchemaParse {
		package: String,
		file: String,
		error: String,
	},
	/// I/O error
	Io(String),
	/// Package not found in search paths
	PackageNotFound {
		name: String,
		search_paths: Vec<PathBuf>,
	},
	/// Package name mismatch
	NameMismatch { expected: String, found: String },
	/// Duplicate type in same package
	DuplicateType { package: String, type_name: String },
	/// Type collision across packages
	TypeCollision { type_name: String },
	/// Undefined type reference
	UndefinedTypeReference { type_name: String, context: String },
	/// Circular dependency
	CircularDependency { package: String },
}

impl std::fmt::Display for PackageError {
	fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
		match self {
			PackageError::ManifestParse(e) => write!(f, "Failed to parse package manifest: {}", e),
			PackageError::SchemaParse { package, file, error } => {
				write!(f, "Failed to parse schema in package '{}', file '{}': {}", package, file, error)
			}
			PackageError::Io(e) => write!(f, "I/O error: {}", e),
			PackageError::PackageNotFound { name, search_paths } => {
				write!(f, "Package '{}' not found in search paths: {:?}", name, search_paths)
			}
			PackageError::NameMismatch { expected, found } => {
				write!(f, "Package name mismatch: expected '{}', found '{}'", expected, found)
			}
			PackageError::DuplicateType { package, type_name } => {
				write!(f, "Duplicate type '{}' in package '{}'", type_name, package)
			}
			PackageError::TypeCollision { type_name } => {
				write!(f, "Type name collision: '{}' is defined in multiple packages", type_name)
			}
			PackageError::UndefinedTypeReference { type_name, context } => {
				write!(f, "Undefined type reference '{}' in {}", type_name, context)
			}
			PackageError::CircularDependency { package } => {
				write!(f, "Circular dependency detected involving package '{}'", package)
			}
		}
	}
}

impl std::error::Error for PackageError {}

// endregion: --- Error Types

// region:    --- Import Parsing

/// Extract import declarations from schema content
///
/// Looks for lines like:
///   import "package-name";
///   import "security-binary";
fn extract_imports(content: &str) -> Vec<String> {
	let mut imports = Vec::new();

	for line in content.lines() {
		let line = line.trim();
		if line.starts_with("import ") {
			// Parse: import "package-name";
			if let Some(rest) = line.strip_prefix("import ") {
				let rest = rest.trim().trim_end_matches(';').trim();
				if let Some(name) = rest.strip_prefix('"') {
					if let Some(name) = name.strip_suffix('"') {
						imports.push(name.to_string());
					}
				}
			}
		}
	}

	imports
}

// endregion: --- Import Parsing

// region:    --- Tests

#[cfg(test)]
mod tests {
	use super::*;
	use std::fs;
	use tempfile::TempDir;

	fn create_test_package(dir: &Path, name: &str, deps: &[(&str, &str)]) -> std::io::Result<()> {
		fs::create_dir_all(dir.join("schema"))?;

		// Create manifest
		let mut manifest = format!(
			r#"
name = "{}"
version = "0.1.0"
schemas = ["schema/00_domain.hel"]
"#,
			name
		);

		if !deps.is_empty() {
			manifest.push_str("\n[dependencies]\n");
			for (dep_name, dep_version) in deps {
				manifest.push_str(&format!("{} = \"{}\"\n", dep_name, dep_version));
			}
		}

		fs::write(dir.join("hel-package.toml"), manifest)?;

		// Create simple schema
		let schema = format!(
			r#"
type {}Type {{
    value: String
}}
"#,
			name.replace('-', "_")
		);
		fs::write(dir.join("schema/00_domain.hel"), schema)?;

		Ok(())
	}

	#[test]
	fn test_package_manifest_parse() {
		let toml = r#"
name = "test-package"
version = "1.0.0"
schemas = ["schema/00_domain.hel"]

[dependencies]
other-package = "0.1.0"
"#;

		let manifest = PackageManifest::from_toml(toml).expect("parse failed");
		assert_eq!(manifest.name, "test-package");
		assert_eq!(manifest.version, "1.0.0");
		assert_eq!(manifest.schemas.len(), 1);
		assert_eq!(manifest.dependencies.len(), 1);
	}

	#[test]
	fn test_extract_imports() {
		let content = r#"
import "core-types";
import "security-binary";

type MyType {
    field: String
}
"#;

		let imports = extract_imports(content);
		assert_eq!(imports.len(), 2);
		assert_eq!(imports[0], "core-types");
		assert_eq!(imports[1], "security-binary");
	}

	#[test]
	fn test_package_loading() -> Result<(), Box<dyn std::error::Error>> {
		let temp = TempDir::new()?;
		let pkg_dir = temp.path().join("test-pkg");
		create_test_package(&pkg_dir, "test-pkg", &[])?;

		let package = SchemaPackage::from_directory(&pkg_dir)?;
		assert_eq!(package.manifest.name, "test-pkg");
		assert_eq!(package.schema.types.len(), 1);

		Ok(())
	}

	#[test]
	fn test_package_registry_loading() -> Result<(), Box<dyn std::error::Error>> {
		let temp = TempDir::new()?;
		let pkg_dir = temp.path().join("test-pkg");
		create_test_package(&pkg_dir, "test-pkg", &[])?;

		let mut registry = PackageRegistry::new();
		registry.add_search_path(temp.path().to_path_buf());

		let package = registry.load_package("test-pkg")?;
		assert_eq!(package.manifest.name, "test-pkg");

		Ok(())
	}

	#[test]
	fn test_dependency_resolution() -> Result<(), Box<dyn std::error::Error>> {
		let temp = TempDir::new()?;

		// Create base package
		let base_dir = temp.path().join("base-pkg");
		create_test_package(&base_dir, "base-pkg", &[])?;

		// Create dependent package
		let dep_dir = temp.path().join("dep-pkg");
		create_test_package(&dep_dir, "dep-pkg", &[("base-pkg", "0.1.0")])?;

		let mut registry = PackageRegistry::new();
		registry.add_search_path(temp.path().to_path_buf());

		let resolved = registry.resolve_all("dep-pkg")?;
		assert_eq!(resolved.len(), 2);
		assert_eq!(resolved[0], "base-pkg"); // dependency first
		assert_eq!(resolved[1], "dep-pkg");

		Ok(())
	}

	#[test]
	fn test_type_environment_building() -> Result<(), Box<dyn std::error::Error>> {
		let temp = TempDir::new()?;
		let pkg_dir = temp.path().join("test-pkg");
		create_test_package(&pkg_dir, "test-pkg", &[])?;

		let mut registry = PackageRegistry::new();
		registry.add_search_path(temp.path().to_path_buf());

		let resolved = registry.resolve_all("test-pkg")?;
		let env = registry.build_type_environment(&resolved)?;

		// Type should be qualified as "test-pkg.test_pkgType"
		assert!(env.get_type("test-pkg.test_pkgType").is_some());

		Ok(())
	}

	#[test]
	fn test_circular_dependency_detection() -> Result<(), Box<dyn std::error::Error>> {
		let temp = TempDir::new()?;

		// Create pkg-a depending on pkg-b
		let a_dir = temp.path().join("pkg-a");
		create_test_package(&a_dir, "pkg-a", &[("pkg-b", "0.1.0")])?;

		// Create pkg-b depending on pkg-a (circular!)
		let b_dir = temp.path().join("pkg-b");
		create_test_package(&b_dir, "pkg-b", &[("pkg-a", "0.1.0")])?;

		let mut registry = PackageRegistry::new();
		registry.add_search_path(temp.path().to_path_buf());

		let result = registry.resolve_all("pkg-a");
		assert!(result.is_err());
		assert!(matches!(result.unwrap_err(), PackageError::CircularDependency { .. }));

		Ok(())
	}
}

// endregion: --- Tests