READMEmoonbit-community/proton/command does not have a README file
#AppCommandRequestContext
Request-scoped context for one bridged app command dispatch.
#CommandContext
Request-scoped context supplied to typed application command handlers.
Lifecycle-owned task and event capabilities are added by the application
runner; the registrar keeps handlers independent from transport details.
#ExtensionSpecError
pub(all) suberror ExtensionSpecError {
InvalidContract(detail~ : String)
ForeignCommandRoute(extension_id~ : String, operation_name~ : String)
} derive(Eq)Invalid typed metadata supplied while constructing an extension spec.
#ExtensionSpecError::message
#PermissionScopeValidationError
A stable validation failure for an extension's renderer permission scope.
#PermissionScopeValidationError::message
#AppCommandApiDescriptor
pub struct AppCommandApiDescriptor {
api_name : String
}One JavaScript-facing API descriptor exposed by a user app command extension.
#AppCommandApiDescriptor::api_name
#AppCommandApiDescriptor::new
#AppCommandApiDescriptor::to_ipc_api
#AppCommandExtensionDescriptor
pub struct AppCommandExtensionDescriptor {
id : String
js_namespace : String
apis : Array[AppCommandApiDescriptor]
scripts : Array[String]
}JavaScript bridge metadata exposed by a user app command extension.
#AppCommandExtensionDescriptor::new
fn AppCommandExtensionDescriptor::new(id : String, js_namespace : String, apis : Array[AppCommandApiDescriptor], scripts? : Array[String]) -> AppCommandExtensionDescriptor#AppCommandExtensionDescriptor::to_ipc_descriptor
fn AppCommandExtensionDescriptor::to_ipc_descriptor(self : AppCommandExtensionDescriptor) -> IpcExtensionDescriptor#AppCommandExtensionRegistry
pub struct AppCommandExtensionRegistry {
specs : Map[String, AppCommandExtensionSpec]
registration_order : Array[String]
}Registry of command extension specs available to one user app process.
#AppCommandExtensionRegistry::get
fn AppCommandExtensionRegistry::get(self : AppCommandExtensionRegistry, id : String) -> AppCommandExtensionSpec?#AppCommandExtensionRegistry::new
#AppCommandExtensionRegistry::ordered_names
#AppCommandExtensionRegistry::register
fn AppCommandExtensionRegistry::register(self : AppCommandExtensionRegistry, spec : AppCommandExtensionSpec) -> AppCommandExtensionRegistry#AppCommandExtensionRegistry::registered_ids
#AppCommandExtensionRegistry::spec_map
fn AppCommandExtensionRegistry::spec_map(self : AppCommandExtensionRegistry) -> Map[String, AppCommandExtensionSpec]#AppCommandExtensionSpec
pub struct AppCommandExtensionSpec {
id : String
js_namespace : String
apis : Array[AppCommandApiDescriptor]
scripts : Array[String]
dependencies : Array[String]
register : (CommandRegistrar) -> Unit raise
resolve_permission : (Json, String) -> Json raise PermissionScopeValidationError
on_destroy : () -> Unit raise
}Declarative user-process command extension spec.
#AppCommandExtensionSpec::apis
#AppCommandExtensionSpec::dependencies
#AppCommandExtensionSpec::destroy
#AppCommandExtensionSpec::id
#AppCommandExtensionSpec::js_namespace
#AppCommandExtensionSpec::op_names
#AppCommandExtensionSpec::register
fn AppCommandExtensionSpec::register(self : AppCommandExtensionSpec, registrar : CommandRegistrar) -> Unit raise#AppCommandExtensionSpec::resolve_permission
fn AppCommandExtensionSpec::resolve_permission(self : AppCommandExtensionSpec, scope : Json, base_path : String) -> Json raise PermissionScopeValidationError#AppCommandExtensionSpec::scripts
#AppCommandExtensionSpec::to_ipc_descriptor
fn AppCommandExtensionSpec::to_ipc_descriptor(self : AppCommandExtensionSpec) -> IpcExtensionDescriptor#AppCommandExtensionSpec::typed
fn AppCommandExtensionSpec::typed(contract : ExtensionContract, command_routes : Array[ContractRoute], register : (CommandRegistrar) -> Unit raise, scripts? : Array[String], dependencies? : Array[String], resolve_permission? : (Json, String) -> Json raise PermissionScopeValidationError, on_destroy? : () -> Unit raise) -> AppCommandExtensionSpec raise ExtensionSpecErrorCreates an extension spec whose JavaScript APIs and native operation names
are derived from typed extension command descriptors.
#AppCommandsConfig
pub struct AppCommandsConfig {
op_names : Array[String]
extensions : Array[IpcExtensionDescriptor]
framework_extension_ids : Array[String]
}Commands exposed by the user app process to the framework runtime.
#AppCommandsConfig::extensions
#AppCommandsConfig::framework_extension_ids
#AppCommandsConfig::from_ipc_descriptors
fn AppCommandsConfig::from_ipc_descriptors(op_names : Array[String], extensions : Array[IpcExtensionDescriptor], framework_extension_ids : Array[String]) -> AppCommandsConfig#AppCommandsConfig::new
fn AppCommandsConfig::new(op_names : Array[String], extensions? : Array[AppCommandExtensionDescriptor], framework_extension_ids? : Array[String]) -> AppCommandsConfig#AppCommandsConfig::op_names
#CommandRegistrar
Startup-only capability for binding typed command descriptors to handlers.
#CommandRegistrar::bind
fn[Request : FromJson, Response : ToJson] CommandRegistrar::bind(self : CommandRegistrar, command : Command[Request, Response], handler : async (AppCommandRequestContext, Request) -> Response) -> Unit raiseBinds one typed descriptor to an asynchronous command handler.
Request decoding and response encoding are selected from the descriptor's
type parameters. The descriptor is the only source of command identity.
#app_command_extension_op_name
fn app_command_extension_op_name(js_namespace : String, api_name : String) -> String#app_command_js_property_is_reserved
fn app_command_js_property_is_reserved(name : String) -> Bool
MoonBit bindings for the Proton native desktop runtime.
protonguiwebdesktop-app
0.1.16
Apache-2.0
Updated 3 days ago
37 downloadsDependencies