Skip to main content

platform_module/
lib.rs

1//! Module framework contracts: the data/behavior split a module exposes to the
2//! composition root.
3//!
4//! - [`ModuleManifest`]: serializable data (name, story display, reserved
5//!   seams). Produced by every loading source.
6//! - [`ModuleBinding`]: behavior (register functions/event handlers). One impl
7//!   per loading source; [`LinkedBinding`] is the compile-time one.
8//! - [`Module`]: a loaded module bundling manifest + binding + internal config.
9//! - [`AdminDataSource`]: the schema-admin read seam — a module's read access
10//!   to its admin entities. [`AdminSchema`] is the declared admin surface data.
11//! - [`AdminActionSource`]: executable behavior for manifest-declared admin
12//!   actions.
13//! - [`AdminQuerySource`]: read-only behavior for manifest-declared admin
14//!   queries.
15
16mod admin_data;
17mod binding;
18mod host;
19mod linked;
20mod module;
21
22pub use admin_data::{
23    AdminActionSource, AdminDataSource, AdminListQuery, AdminPage, AdminQuerySource,
24};
25pub use binding::{EventHandlerRegistrationContext, EventHandlerRuntimeContext, ModuleBinding};
26pub use host::{HostContribution, HostLinkedModule};
27pub use lenso_contracts::{
28    AdminAction, AdminActionConfirmation, AdminActionDangerLevel, AdminActionInputField,
29    AdminActionInputSchema, AdminDeclarativeComponent, AdminDeclarativePage,
30    AdminDeclarativeSection, AdminDeclarativeSurface, AdminEmbeddedEntry, AdminEmbeddedRuntime,
31    AdminEmbeddedSurface, AdminMetricBinding, AdminPermission, AdminSandboxPolicy, AdminSchema,
32    AdminSurface, ConsoleArea, ConsoleNavigation, ConsoleNavigationGroup, ConsolePackage,
33    ConsoleSurface, ConsoleWorkspaceRef, CronParseError, CronSchedule, EntitySchema,
34    EventHandlerDeclaration, EventSurface, FieldSchema, FieldType,
35    LifecycleActivationJobDeclaration, LifecycleActivationRunPolicy,
36    LifecycleStartupCheckDeclaration, LifecycleStartupCheckKind, LifecycleSurface,
37    ModuleCapabilityReference, ModuleHttpMethod, ModuleHttpRoute, ModuleManifest,
38    ModuleManifestBuilder, ModuleManifestLint, ModuleManifestLintSeverity, ModuleRouteLint,
39    ModuleRouteLintSeverity, ModuleSource, RuntimeFunctionDeclaration,
40    RuntimeRetryPolicyDeclaration, RuntimeSurface, StoryDisplayDescriptor, StoryDisplaySource,
41    lint_module_http_routes, lint_module_manifest, lint_module_manifest_parts,
42    module_capability_references, validate_cron_expression,
43};
44pub use linked::{
45    LinkedBinding, LinkedBindingBuilder, LinkedHttpContribution, LinkedHttpRouteMerger,
46};
47pub use module::{Module, ModuleLoadStatus};
48
49#[cfg(test)]
50mod tests {
51    use super::*;
52    use platform_core::{AppContext, Migration};
53
54    #[derive(Debug, Clone, PartialEq, Eq)]
55    struct TestContribution(&'static str);
56
57    const TEST_MIGRATIONS: &[Migration] = &[Migration {
58        name: "test/0001_init",
59        sql: "select 1;",
60    }];
61
62    fn manifest() -> ModuleManifest {
63        ModuleManifest::builder("test").build()
64    }
65
66    fn module(_ctx: &AppContext) -> Module {
67        Module::linked(manifest(), LinkedBinding::builder().build())
68    }
69
70    #[test]
71    fn host_linked_module_keeps_typed_contributions() {
72        let linked_module = HostLinkedModule::linked("test", manifest, module, TEST_MIGRATIONS)
73            .with_contribution(TestContribution("wired"));
74
75        let contributions = linked_module
76            .contributions::<TestContribution>()
77            .collect::<Vec<_>>();
78
79        assert_eq!(contributions, vec![&TestContribution("wired")]);
80    }
81}