Expand description
Morphir Extension SDK
This crate provides the SDK for building Morphir extensions as WASM plugins. Extensions communicate with the host daemon via JSON-RPC 2.0 payloads.
§Platform boundary
Protocol types and extension traits compile on native and WASM targets. The
Extism PDK, guest exports, and imported host functions compile only for
wasm32. Native hosts must use the Extism runtime crate and must not link
guest PDK imports.
§Quick Start
use morphir_extension_sdk::prelude::*;
#[derive(Default)]
struct MyExtension;
impl Extension for MyExtension {
fn info() -> ExtensionInfo {
ExtensionInfo {
id: "my-extension".into(),
name: "My Extension".into(),
version: env!("CARGO_PKG_VERSION").into(),
types: vec![ExtensionType::Frontend],
..Default::default()
}
}
fn capabilities() -> ExtensionCapabilities {
ExtensionCapabilities {
frontend: Some(FrontendCapability {
languages: vec![LanguageCapability {
id: "my-lang".into(),
file_extensions: vec![".ml".into()],
}],
ir_versions: vec!["3".into()],
compile: true,
incremental: false,
fragments: false,
multi_document: false,
}),
..ExtensionCapabilities::default()
}
}
}
impl Frontend for MyExtension {
fn compile(&self, request: CompileRequest) -> Result<CompileResult> {
Ok(CompileResult {
success: true,
ir_version: Some(request.options.ir_version),
ir: Some(serde_json::json!({})),
diagnostics: vec![],
modules: request.package.exposed_modules.unwrap_or_default(),
module_results: vec![],
context_digest: None,
})
}
fn supported_languages() -> Vec<String> {
vec!["my-lang".into()]
}
fn file_extensions() -> Vec<String> {
vec![".ml".into()]
}
}
let request = CompileRequest {
language_id: "my-lang".into(),
sources: SourceSet {
root: None,
documents: vec![SourceDocument {
uri: "file:///workspace/Example.ml".into(),
language_id: "my-lang".into(),
version: 1,
text: "module Example".into(),
}],
},
package: CompilePackage {
name: "local/example".into(),
exposed_modules: Some(vec!["Example".into()]),
},
dependencies: vec![],
options: CompileOptions {
types_only: false,
ir_version: "3".into(),
extra: Default::default(),
},
baseline: None,
};
let result = MyExtension.compile(request).expect("frontend should compile");
assert!(result.success);
morphir_extension_sdk::export_extension!(MyExtension, frontend);Re-exports§
pub use error::ExtensionError;pub use error::Result;pub use native::NativeBackend;pub use native::NativeExtension;pub use native::NativeFrontend;pub use native::NativeProtocol;pub use native::NativeWorkspace;pub use source::SourceContextError;pub use source::SourcePath;pub use source::SourceRoot;pub use traits::Backend;pub use traits::Extension;pub use traits::Frontend;pub use traits::Transform;pub use traits::Validator;pub use traits::Workspace;pub use types::*;
Modules§
- claims
- Guest-authored capability claim sets, independent of a negotiated session.
- error
- Error types for the Morphir extension SDK
- model
- Rich MorphirModel messages and validated transport boundaries.
- native
- Native adapters for invoking extension implementations without WASM.
- prelude
- Prelude module for convenient imports
- protocol
- JSON-RPC 2.0 protocol types for extension communication
- source
- Source identities within one compilation unit. These operations perform no I/O.
- traits
- Extension traits defining the contract between extensions and the host
- types
- Core types for the Morphir extension system
Macros§
- export_
extension - Export an extension implementation with JSON-RPC dispatch
- host_
debug - host_
error - host_
info - host_
warn