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, EntitySchema, EventHandlerDeclaration, EventSurface,
34    FieldSchema, FieldType, LifecycleActivationJobDeclaration, LifecycleActivationRunPolicy,
35    LifecycleStartupCheckDeclaration, LifecycleStartupCheckKind, LifecycleSurface,
36    ModuleCapabilityReference, ModuleHttpMethod, ModuleHttpRoute, ModuleManifest,
37    ModuleManifestBuilder, ModuleManifestLint, ModuleManifestLintSeverity, ModuleRouteLint,
38    ModuleRouteLintSeverity, ModuleSource, RuntimeFunctionDeclaration,
39    RuntimeRetryPolicyDeclaration, RuntimeSurface, StoryDisplayDescriptor, StoryDisplaySource,
40    lint_module_http_routes, lint_module_manifest, lint_module_manifest_parts,
41    module_capability_references,
42};
43pub use linked::{
44    LinkedBinding, LinkedBindingBuilder, LinkedHttpContribution, LinkedHttpRouteMerger,
45};
46pub use module::{Module, ModuleLoadStatus};
47
48#[cfg(test)]
49mod tests {
50    use super::*;
51    use platform_core::{AppContext, Migration};
52
53    #[derive(Debug, Clone, PartialEq, Eq)]
54    struct TestContribution(&'static str);
55
56    const TEST_MIGRATIONS: &[Migration] = &[Migration {
57        name: "test/0001_init",
58        sql: "select 1;",
59    }];
60
61    fn manifest() -> ModuleManifest {
62        ModuleManifest::builder("test").build()
63    }
64
65    fn module(_ctx: &AppContext) -> Module {
66        Module::linked(manifest(), LinkedBinding::builder().build())
67    }
68
69    #[test]
70    fn host_linked_module_keeps_typed_contributions() {
71        let linked_module = HostLinkedModule::linked("test", manifest, module, TEST_MIGRATIONS)
72            .with_contribution(TestContribution("wired"));
73
74        let contributions = linked_module
75            .contributions::<TestContribution>()
76            .collect::<Vec<_>>();
77
78        assert_eq!(contributions, vec![&TestContribution("wired")]);
79    }
80}