alizarin-core 2.0.0-alpha.118

Core data structures and algorithms for Arches heritage graph and tile processing
Documentation
/// The version of alizarin-core (from Cargo.toml at compile time).
pub const VERSION: &str = env!("CARGO_PKG_VERSION");

pub mod card_traversal;
pub mod csv_business_data_loader;
pub mod csv_model_loader;
pub mod exporter;
/// Alizarin Core Library
///
/// Platform-agnostic core functionality that can be used from:
/// - JavaScript/TypeScript via WASM bindings (alizarin-wasm)
/// - Python via PyO3 bindings (alizarin-python)
/// - Native Rust applications (alizarin-explorer)
/// - Other languages via C FFI
pub mod extension_type_registry;
pub mod graph;
pub mod graph_model_access;
pub mod graph_mutator;
pub mod instance_wrapper_core;
pub mod interner;
pub mod json_conversion;
pub mod label_resolution;
pub mod loader;
pub mod node_config;
pub mod ontology;
pub mod path_resolution;
pub mod permissions;
pub mod pseudo_value_core;
pub mod rdm_cache;
pub mod rdm_namespace;
pub mod registry;
pub mod skos;
pub mod string_utils;
pub mod tile_source;
pub mod type_coercion;
pub mod type_serialization;

// Graph types
pub use graph::{
    batch_merge_resources,
    build_backedges,
    find_root_node,
    is_iterable_datatype,
    merge_resources,
    parse_resources_from_json_str,
    // Graph pruning
    prune_graph,
    BatchMergeResult,
    GraphWrapper,
    IndexedGraph,
    // Resource merging
    MergeAccumulator,
    MergeResult,
    // Resource registry for relationship resolution
    PopulateCachesResult,
    PruneError,
    RelatedResourceEntry,
    ResourceCache,
    ResourceEntry,
    StaticCard,
    StaticCardsXNodesXWidgets,
    // Additional Static* types
    StaticConstraint,
    StaticEdge,
    StaticFunctionsXGraphs,
    StaticGraph,
    StaticGraphMeta,
    StaticNode,
    StaticNodegroup,
    StaticPublication,
    StaticResource,
    StaticResourceDescriptors,
    StaticResourceMetadata,
    StaticResourceReference,
    StaticResourceRegistry,
    StaticResourceSummary,
    StaticTile,
    StaticTranslatableString,
    UnknownReference,
    ITERABLE_DATATYPES,
};

// Loader
pub use loader::{
    import_prebuild, load_collections_from_dir, load_ontology_xml_from_dir,
    parse_business_data_bytes, ImportPrebuildResult, LoaderError, PrebuildInfo, PrebuildLoader,
};

// Exporter
pub use exporter::{
    build_prebuild_export, export_all_graphs, export_collections, export_graphs,
    export_single_collection, ExportError, ExportFile, PrebuildExportData,
};

#[cfg(not(target_arch = "wasm32"))]
pub use exporter::fs_writer::{export_prebuild_to_directory, write_to_directory};

// Interner types
#[cfg(feature = "multi-threaded")]
pub use interner::ThreadSafeInterner;
pub use interner::{InternedId, Interner, InternerExt};

// Node config types
pub use node_config::{
    NodeConfig, NodeConfigBoolean, NodeConfigConcept, NodeConfigDomain, NodeConfigManager,
    NodeConfigReference, StaticDomainValue,
};

// Type coercion
pub use type_coercion::{
    // Phase 3: Config-dependent types
    coerce_boolean,
    coerce_concept_list,
    // Phase 4: RDM-dependent types
    coerce_concept_value,
    // Phase 1: Simple scalars
    coerce_date,
    coerce_domain_value,
    coerce_domain_value_list,
    coerce_edtf,
    // Phase 2: Dict types
    coerce_geojson,
    coerce_non_localized_string,
    coerce_number,
    // Phase 5: Format normalization
    coerce_resource_instance,
    coerce_resource_instance_list,
    coerce_string,
    coerce_url,
    // Dispatcher and result
    coerce_value,
    coerce_value_with_registry,
    // Language configuration
    get_current_language,
    set_current_language,
    CoercionResult,
    DEFAULT_LANGUAGE,
};

// Type serialization (output formatting)
pub use type_serialization::{
    // Individual serializers
    serialize_boolean,
    serialize_concept,
    serialize_concept_list,
    serialize_date,
    serialize_display,
    serialize_domain_value,
    serialize_domain_value_list,
    serialize_edtf,
    serialize_geojson,
    serialize_non_localized_string,
    serialize_number,
    serialize_resource_instance,
    serialize_resource_instance_list,
    serialize_string,
    serialize_tile_data,
    serialize_url,
    // Dispatcher functions
    serialize_value,
    // Context and resolvers
    ExternalResolver,
    ResourceDisplayResolver,
    SerializationContext,
    // Options and result
    SerializationMode,
    SerializationOptions,
    SerializationResult,
};

// Label resolution
pub use label_resolution::{
    build_alias_to_collection_map, find_needed_collections, is_valid_uuid, resolve_labels,
    resolve_labels_full, ConceptLookup, LabelResolutionConfig, LabelResolutionError,
    DEFAULT_CONFIG_KEYS, DEFAULT_RESOLVABLE_DATATYPES,
};

// Card-based traversal (card hierarchy instead of node hierarchy)
pub use card_traversal::{
    cards_to_tree, serialize_card, serialize_root_cards, CardSerializationParams,
};

// JSON conversion (tiles <-> tree)
pub use json_conversion::{
    build_tree_from_tiles, create_static_resource, resource_tiles_to_tree, tiles_to_tree,
    tree_to_tiles, tree_to_tiles_with_options, BusinessData, BusinessDataWrapper,
};

// Pseudo value core types (for JSON conversion)
pub use pseudo_value_core::{
    matches_tile_filter, PseudoListCore, PseudoValueCore, TileBuilder, TileBuilderContext,
    VisitorContext,
};

// Instance wrapper core types (for populate, semantic traversal)
pub use instance_wrapper_core::{
    create_pseudo_list_from_tiles, ensure_nodegroup, is_node_single_cardinality,
    is_node_single_cardinality_with, matches_semantic_child, resolve_and_filter_tiles,
    values_from_resource_nodegroup, EnsureNodegroupResult, LoadState, ModelAccess, PopulateResult,
    ResourceInstanceWrapperCore, SemanticChildError, SemanticChildResult,
    ValuesFromNodegroupResult,
};

// Platform-agnostic ModelAccess from StaticGraph (used by Python, NAPI, etc.)
pub use graph_model_access::GraphModelAccess;

// Path resolution (dot-separated path → nodegroup tiles)
pub use path_resolution::{resolve_path_segments, PathError, PathResolutionInfo};

// Tile source trait (pluggable tile backends)
pub use tile_source::{TileSource, TileSourceError};

// RDM cache types
pub use rdm_cache::{
    rdm_to_skos_collection, rdm_to_skos_collection_excluding, skos_to_rdm_collection, RdmCache,
    RdmCollection, RdmConcept,
};

// RDM namespace utilities (deterministic UUID generation)
pub use rdm_namespace::{
    clear_rdm_namespace, generate_collection_uuid, generate_concept_uuid,
    generate_concept_uuid_from_str, generate_value_uuid, get_rdm_namespace, has_rdm_namespace,
    labels_to_deterministic_string, parse_rdm_namespace, set_rdm_namespace,
};

// Graph mutator types (builder pattern for graph construction)
pub use graph_mutator::{
    apply_instructions,
    apply_mutations,
    apply_mutations_create_from_json,
    apply_mutations_from_json,
    apply_mutations_from_json_with_extensions,
    // Extension-aware mutation API
    apply_mutations_with_extensions,
    build_graph_from_instructions,
    build_graph_from_instructions_csv,
    build_graph_from_instructions_json,
    build_graph_from_instructions_with_extensions,
    default_card_component,
    generate_uuid_v5,
    get_default_widget_for_datatype,
    get_mutation_schema,
    mutations_to_json,
    parse_instructions_from_csv,
    slugify,
    AddCardParams,
    AddEdgeParams,
    AddNodeParams,
    AddNodegroupParams,
    AddWidgetParams,
    CardComponent,
    CardOptions,
    // Utilities
    Cardinality,
    CreateGraphParams,
    ExtensionMutationHandler,
    // Extension mutations
    ExtensionMutationParams,
    ExtensionMutationRegistry,
    // Instruction-based API
    GraphInstruction,
    // Mutation types (Command pattern)
    GraphMutation,
    // Builder and options
    GraphMutator,
    MutationConformance,
    MutationError,
    // JSON-based mutation API
    MutationRequest,
    MutationRequestOptions,
    MutatorOptions,
    NodeOptions,
    RenameGraphParams,
    RenameNodeParams,
    // Widget types
    Widget,
    DEFAULT_CARD_COMPONENT_ID,
    WIDGETS,
};

// Ontology validation
pub use ontology::{OntologyConfig, OntologyError, OntologyValidationDetail, OntologyValidator};

// Graph registry (for looking up graphs by graph_id)
pub use registry::{
    clear_registry, get_graph, get_registered_graph_ids, is_graph_registered, register_graph,
    register_graph_owned, registry_size, unregister_graph,
};

// List datatype registry (for datatypes where array IS the value)
pub use registry::{
    is_list_datatype, list_datatypes, register_list_datatype, unregister_list_datatype,
};

// Widget mapping registry (for extension datatype -> widget mappings)
pub use registry::{
    get_widget_for_datatype, register_widget_for_datatype, unregister_widget_for_datatype,
    widget_mappings,
};

// Widget registry (for extension widget definitions)
pub use registry::{
    get_registered_widget, register_widget, registered_widgets, unregister_widget, RegisteredWidget,
};

// Global RDM cache (for concept lookups across FFI targets)
pub use registry::{
    add_to_global_rdm_cache_from_skos, add_to_global_rdm_cache_from_skos_xml,
    clear_global_rdm_cache, ensure_global_rdm_cache, get_global_rdm_cache, has_global_rdm_cache,
    set_global_rdm_cache, with_global_rdm_cache, with_global_rdm_cache_mut,
};

// Permission rules (for conditional tile filtering)
pub use permissions::{evaluate_tile_path, PermissionRule};

// String utilities
pub use string_utils::{camel_to_snake, snake_to_camel, sort_json_keys, transform_keys_to_snake};

// Extension type registry (unified handler infrastructure for WASM/Python)
pub use extension_type_registry::{
    ExtensionError, ExtensionTypeHandler, ExtensionTypeRegistry, HandlerCapabilities,
};

// CSV model loader (3-CSV format: graph.csv, nodes.csv, collections.csv)
pub use csv_model_loader::{
    build_graph_from_model_csvs, model_csvs_to_collections, model_csvs_to_instructions,
    parse_model_csvs, validate_model_csvs, validate_model_csvs_from_strings, CollectionRow,
    CsvModelDiagnostic, CsvModelError, DiagnosticLevel, GraphRow, ModelCsvBundle, NodeRow,
};

// CSV business data loader
pub use csv_business_data_loader::{
    build_resources_from_business_csv, wrap_business_data, BusinessDataCsvOptions,
};