🥮 mooncakes.io
    Sign in

    proton

    MoonBit bindings for the Proton native desktop runtime.

    proton
    gui
    web
    desktop-app
    Download zip
    Version
    0.1.17
    License
    Apache-2.0
    Repository
    Last updated
    2 months ago
    Downloads
    26K

    #moonbit-community/proton

    MoonBit facade for building Proton desktop applications on the native runtime. This package is the public app surface: windows, entries, commands, events, and lifecycle hooks are all configured from MoonBit code. For the full development workflow — scaffolding, CEF runtime setup, dev mode, and packaging — see the repository README and the proton_cli tool.

    #Quick example

    async fn main {
      @proton.html("Hello", "<h1>Hello</h1>").run_or_abort()
    }

    main is async because Proton hands its own event loop to moonbitlang/async during process initialization; from then on every line of MoonBit runs on the main thread and only async's waiting half moves to a thread of its own. Nothing has to be installed by hand, but the package must import moonbitlang/async for async fn main to be available at all. @proton.html accepts optional width?, height?, debug?, and resizable? arguments.

    #Entry points

    • @proton.html(title, html, ...) — inline HTML document.
    • @proton.url(title, url, ...) — a remote or local URL.
    • @proton.file(title, path, ...) — an HTML file on disk.
    • @proton.asset(title, path, ...) — an HTML asset shipped with the app.
    • @proton.config("proton.project.json") — an app described by a proton.project.json file.
    • @proton.app() — config from PROTON_CONFIG_PATH, proton.project.json in the current working directory, or code-only defaults.

    #Commands and events

    Register typed commands on the app builder:

    @proton.config("proton.project.json")
    .commands(fn(registrar) raise { registrar.bind(ping_command, ping) })
    .run_or_abort()

    @proton.CommandRegistrar binds contract command descriptors to async handlers; each handler receives a @proton.CommandContext and the decoded request payload. The backend emits events to the renderer with CommandContext::emit(event, payload). JavaScript invokes commands and subscribes to events through the bridge installed on window: commands are called by their contract operation name through core.invokeOp, and backend events arrive on the events channel. For a contract with namespace app:

    const reply = await window.__MoonBit__.core.invokeOp("ext:app/ping", {
  name: "proton",
});
window.__MoonBit__.events.on("app.tick", (event) => console.log(event.payload));

    Extensions built on moonbit-community/proton_ext additionally install namespaced proxies such as window.__MoonBit__.ticker.start(...).

    #Windows

    Add secondary windows to the app builder:

    @proton.html("Main", main_html)
    .add_window(
      "settings",
      "Settings",
      @proton.AppEntry::Html(settings_html),
      width=420,
      height=320,
    )

    The window id "main" is reserved for the primary window. The process exits when all windows have closed.

    #Headless mode

    .headless() runs the app off-screen without creating a native window. Set PROTON_HEADLESS=1 to force headless mode for automated test runs.

    #Application locale

    App::locale selects an immutable application locale before native runtime creation. The resolved locale and preferred language order are available from application, window, and command contexts and are also supplied to CEF. Applications own their translation catalogs and localized content; Proton only owns platform discovery, propagation, standard native menu labels, and its framework failure shell.

    #Learn more

    • Runnable demos live in the repository's examples/ directory.
    • The CLI covers the project workflow: proton_cli new, proton_cli cef setup, proton_cli dev, proton_cli build, and proton_cli package.

    AppEntry

    source

    Declarative entry content loaded into a Proton application window.

    BridgeDiagnostic

    source

    BridgeLifecycleState

    source

    CommandContext

    source

    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.

    CommandRegistrar

    source

    Startup-only capability for binding typed command descriptors to handlers.

    Locale

    source

    A canonical RFC 5646 language tag.

    LocaleParseError

    source

    Failures produced while parsing an RFC 5646 language tag.

    A top-level native menu and its items.

    An application-level native menu bar.

    A command, separator, or platform role in a native menu.

    A standard native menu action.

    A standard top-level application menu role.

    NativeError

    source

    Failures at the MoonBit/native runtime boundary.

    PermissionGrant

    source

    Grants one extension to one trusted source in one application window.

    Extension registration and permission grants are deliberately separate: registering an extension makes its backend implementation available, while a grant decides which renderer may invoke it. scope is interpreted by the extension and is always copied at the manifest boundary.

    PermissionOrigin

    source

    Selects the trusted page source covered by a permission grant.

    PermissionScopeValidationError

    source

    A stable validation failure for an extension's renderer permission scope.

    ProcessResult

    source

    Runtime

    source

    RuntimeConfig

    source

    RuntimeEvent

    source

    RuntimeInfo

    source

    RuntimeLaunchInput

    source

    A macOS application activation delivered by Launch Services or the Dock.

    ScreenInfo

    source

    Information about a single connected display.

    TitlebarStyle

    source

    Window

    source

    WindowConfig

    source

    WindowMonitor

    source

    Geometry and scaling information for the monitor containing a window.

    WindowSizeHint

    source

    Controls how the configured width and height constrain native resizing.

    WindowState

    source

    A point-in-time native window state snapshot.

    AppCleanupError

    source

    A failure from one stage of best-effort application teardown.

    AppCleanupError::message

    source
    fn AppCleanupError::message(self : AppCleanupError) -> String

    AppCleanupError::output

    source
    fn AppCleanupError::output(self : AppCleanupError, logger : &Logger) -> Unit

    AppCleanupError::to_repr

    source

    AppCleanupError::to_string

    source
    fn AppCleanupError::to_string(self : AppCleanupError) -> String

    AppConfigurationError

    source
    pub(all) suberror AppConfigurationError {
      InvalidSetting(name~ : String, message~ : String)
      Bootstrap(
    BootstrapError    )
      ExtensionDependencyCycle(extension_id~ : String)
      ExtensionUnavailable(extension_id~ : String, requested_by~ : String?, state~ : String)
      ExtensionAdaptationFailed(extension_id~ : String, error~ : 
    ExtensionAdapterError    )
      InvalidJavaScriptNamespace(js_namespace~ : String)
      InvalidJavaScriptApi(js_namespace~ : String, api_name~ : String)
      InvalidEntryUrl(url~ : String, reason~ : String)
      InvalidPermissionGrant(detail~ : String)
      MissingPermissionGrant(extension_id~ : String)
    } derive(
    Debug    )

    Failures while resolving and validating an application's configuration.

    AppConfigurationError::message

    source
    fn AppConfigurationError::message(self : AppConfigurationError) -> String

    AppConfigurationError::output

    source
    fn AppConfigurationError::output(self : AppConfigurationError, logger : &Logger) -> Unit

    AppConfigurationError::to_repr

    source

    AppConfigurationError::to_string

    source
    fn AppConfigurationError::to_string(self : AppConfigurationError) -> String

    AppEntryError

    source
    pub(all) suberror AppEntryError {
      ReadFailed(path~ : String, detail~ : String)
      NativeLoad(action~ : String, error~ : 
    NativeError    )
      ClosedDuringStartup
    } derive(
    Debug    )

    Failures while loading the application's initial document.

    AppEntryError::message

    source
    fn AppEntryError::message(self : AppEntryError) -> String

    AppEntryError::output

    source
    fn AppEntryError::output(self : AppEntryError, logger : &Logger) -> Unit

    AppEntryError::to_repr

    source

    AppEntryError::to_string

    source
    fn AppEntryError::to_string(self : AppEntryError) -> String

    AppPathError

    source
    pub(all) suberror AppPathError {
      InvalidIdentifier(identifier~ : String)
      MissingHomeDirectory(platform~ : String)
      ResourceDirUnavailable
      PlatformProbe(
    NativeError    )
    } derive(Eq, 
    Debug    )

    Failures while resolving framework-owned application paths.

    AppPathError::equal

    source

    AppPathError::message

    source
    fn AppPathError::message(self : AppPathError) -> String

    AppPathError::not_equal

    source
    fn AppPathError::not_equal(x : AppPathError, y : AppPathError) -> Bool

    AppPathError::to_repr

    source

    AppRunError

    source
    pub(all) suberror AppRunError {
      EventLoopError(String)
      ConfigurationError(AppConfigurationError)
      UnsupportedNativeFeature(feature~ : String)
      NativeRuntimeError(action~ : String, error~ : 
    NativeError    )
      CommandExtensionLifecycleError(CommandExtensionLifecycleError)
      LifecycleHookError(LifecycleHookError)
      EntryLoadError(AppEntryError)
      BridgeStartupError(
    BridgeDiagnostic    )
      BridgeRuntimeError(
    BridgeDiagnostic    )
      CleanupFailed(primary~ : String?, failures~ : Array[AppCleanupError])
      UnexpectedTaskFailure(detail~ : String)
    } derive(
    Debug    )

    Failures produced while configuring, starting, or running an application.

    AppRunError::message

    source
    fn AppRunError::message(self : AppRunError) -> String

    AppRunError::output

    source
    fn AppRunError::output(self : AppRunError, logger : &Logger) -> Unit

    AppRunError::to_repr

    source

    AppRunError::to_string

    source
    fn AppRunError::to_string(self : AppRunError) -> String

    CommandExtensionLifecycleError

    source
    pub(all) suberror CommandExtensionLifecycleError {
      ApplicationRegistrationFailed(detail~ : String)
      RegistrationFailed(extension_id~ : String, detail~ : String)
      DestroyFailed(extension_id~ : String, detail~ : String)
    } derive(
    Debug    )

    Failures while starting or stopping command extensions.

    CommandExtensionLifecycleError::message

    source

    CommandExtensionLifecycleError::output

    source

    CommandExtensionLifecycleError::to_repr

    source

    CommandExtensionLifecycleError::to_string

    source

    LifecycleHookError

    source
    pub(all) suberror LifecycleHookError {
      ApplicationStart(index~ : Int, detail~ : String)
      ApplicationShutdown(index~ : Int, detail~ : String)
      WindowReady(index~ : Int, detail~ : String)
      WindowClose(index~ : Int, detail~ : String)
    } derive(
    Debug    )

    Failures produced by application or window lifecycle hooks.

    LifecycleHookError::message

    source
    fn LifecycleHookError::message(self : LifecycleHookError) -> String

    LifecycleHookError::output

    source
    fn LifecycleHookError::output(self : LifecycleHookError, logger : &Logger) -> Unit

    LifecycleHookError::to_repr

    source

    LifecycleHookError::to_string

    source
    fn LifecycleHookError::to_string(self : LifecycleHookError) -> String

    NotificationDeliveryError

    source
    pub(all) suberror NotificationDeliveryError {
      Native(
    NativeError    )
      WaitInterrupted(detail~ : String)
    } derive(Eq, 
    Debug    )

    Failures while starting or waiting for native notification delivery.

    NotificationDeliveryError::equal

    source

    NotificationDeliveryError::message

    source

    NotificationDeliveryError::not_equal

    source

    NotificationDeliveryError::to_repr

    source

    SystemLocaleError

    source
    pub(all) suberror SystemLocaleError {
      NativeQuery(
    NativeError    )
    } derive(
    Debug    )

    Failures produced while querying the operating system's language order.

    SystemLocaleError::message

    source
    fn SystemLocaleError::message(self : SystemLocaleError) -> String

    SystemLocaleError::output

    source
    fn SystemLocaleError::output(self : SystemLocaleError, logger : &Logger) -> Unit

    SystemLocaleError::to_repr

    source

    SystemLocaleError::to_string

    source
    fn SystemLocaleError::to_string(self : SystemLocaleError) -> String

    WindowSessionError

    source
    pub(all) suberror WindowSessionError {
      UnknownWindow(id~ : String)
      AlreadyOpen(id~ : String)
      StaleWindow(id~ : String)
      UnknownView(id~ : String)
      AlreadyExists(id~ : String)
      StaleView(id~ : String)
      Cancelled
      OperationFailed(action~ : String, error~ : 
    NativeError    )
      StartupFailed(id~ : String, error~ : AppRunError)
    } derive(
    Debug    )

    Failures from runtime window lookup, creation, or control.

    WindowSessionError::message

    source
    fn WindowSessionError::message(self : WindowSessionError) -> String

    WindowSessionError::output

    source
    fn WindowSessionError::output(self : WindowSessionError, logger : &Logger) -> Unit

    WindowSessionError::to_repr

    source

    WindowSessionError::to_string

    source
    fn WindowSessionError::to_string(self : WindowSessionError) -> String

    App

    source
    type App

    High-level application facade for ordinary Proton apps.

    App::add_window

    source
    fn App::add_window(self : App, id : String, title : String, entry : 
    AppEntry    , width? : Int, height? : Int, size_hint? : 
    WindowSizeHint    , titlebar_style? : 
    TitlebarStyle    , open_on_start? : Bool) -> App

    Adds a secondary window owned by the standard application lifecycle.

    App::app_lifecycle

    source
    fn[State] App::app_lifecycle(self : App, on_start~ : async (ApplicationContext) -> State, on_shutdown~ : async (State) -> Unit) -> App

    Adds a paired application lifecycle hook.

    The startup state is passed to shutdown. Completed hooks shut down in reverse order, including when a later startup hook fails.

    App::bridge_startup_timeout_ms

    source
    fn App::bridge_startup_timeout_ms(self : App, timeout_ms : Int) -> App

    Sets the maximum time allowed for the native bridge to become ready.

    App::commands

    source
    fn App::commands(self : App, register : (
    CommandRegistrar    ) -> Unit raise) -> App

    Adds one package registrar for typed application commands.

    Registration runs before any window is created and is sealed before the renderer bridge starts accepting requests.

    App::debug

    source
    fn App::debug(self : App, enabled? : Bool) -> App

    Enables or disables runtime debug mode.

    App::debug_level

    source
    fn App::debug_level(self : App, debug : Int) -> App

    Sets the runtime debug level.

    App::entry_asset

    source
    fn App::entry_asset(self : App, path : String) -> App

    Overrides the primary app entry with an asset path.

    App::entry_file

    source
    fn App::entry_file(self : App, path : String) -> App

    Overrides the primary app entry with a file path.

    App::entry_html

    source
    fn App::entry_html(self : App, html : String) -> App

    Overrides the primary app entry with inline HTML.

    App::entry_url

    source
    fn App::entry_url(self : App, url : String) -> App

    Overrides the primary app entry with a URL.

    App::expose

    source

    Registers an extension and explicitly exposes it to one trusted page.

    Use extension plus permission separately when an extension provides a typed permission builder, such as the filesystem extension.

    App::extension

    source

    Registers one extension setting with the app facade.

    The native DLL route exposes command extensions through window.__MoonBit__.core.invokeOp(...) and generated high-level proxies. The renderer installs the bridge before the page's first script executes.

    App::extensions

    source

    Registers a set of extension settings with the app facade.

    App::headless

    source
    fn App::headless(self : App, enabled? : Bool) -> App

    Enables or disables off-screen headless rendering for the application.

    Headless mode does not create a native top-level window. Set PROTON_HEADLESS=1 to force this mode for automated test runs.

    App::locale

    source

    Selects the immutable locale used by this application runtime.

    App::menu

    source

    Sets the app-level native menu bar.

    App::on_certificate_error

    source
    fn App::on_certificate_error(self : App, handler : async (BrowserHandle, CertificateError) -> BrowserPermissionDecision noraise) -> App

    Reviews invalid TLS certificates. The default is denial.

    App::on_download_event

    source
    fn App::on_download_event(self : App, handler : async (BrowserHandle, DownloadEvent) -> Unit noraise) -> App

    Observes download progress and terminal states.

    App::on_download_request

    source
    fn App::on_download_request(self : App, handler : async (BrowserHandle, DownloadRequest) -> DownloadDecision noraise) -> App

    Reviews downloads before CEF chooses a destination.

    App::on_launch_input

    source
    fn App::on_launch_input(self : App, handler : async (
    RuntimeLaunchInput    ) -> Unit noraise) -> App

    App::on_media_permission_request

    source
    fn App::on_media_permission_request(self : App, handler : async (BrowserHandle, MediaPermissionRequest) -> BrowserPermissionDecision noraise) -> App

    Reviews camera, microphone, and display-capture requests. The default is denial.

    App::on_navigation_request

    source
    fn App::on_navigation_request(self : App, handler : async (BrowserHandle, NavigationRequest) -> NavigationDecision noraise) -> App

    Reviews top-level navigations asynchronously. The native browser cancels a pending navigation until this handler returns, then replays it exactly once when allowed.

    App::on_popup_request

    source
    fn App::on_popup_request(self : App, handler : async (BrowserHandle, PopupRequest) -> PopupDecision noraise) -> App

    Reviews window.open and new-tab requests. New Proton windows must already be declared with add_window(..., open_on_start=false).

    App::on_update_available

    source
    fn App::on_update_available(self : App, handler : async (PendingUpdate) -> Unit noraise) -> App

    Registers an application-level handler for URL, file, and reopen inputs. Registers a handler for an update the channel offers.

    Registering one is what turns the automatic check on: an application that has not said what to do when an update exists is not asked to contact a server on launch. The handler runs after the application is up, on the application task group, and never on the startup path.

    It is called with an update that has already been authenticated and found newer. Nothing has been downloaded and nothing will be until the handler asks for it.

    App::on_view_event

    source
    fn App::on_view_event(self : App, handler : async (ViewHandle, ViewEvent) -> Unit noraise) -> App

    Observes lifecycle events for every running web contents view: loading changes, main-frame navigations, title updates, and load failures.

    App::on_window_close_request

    source
    fn App::on_window_close_request(self : App, handler : async (WindowHandle) -> WindowCloseDecision noraise) -> App

    Intercepts user-initiated close requests without blocking the native UI thread. WindowHandle::close uses the same request path; forced cleanup is reserved for the session-owned destroy lifecycle.

    App::on_window_event

    source
    fn App::on_window_event(self : App, handler : async (WindowHandle, WindowEvent) -> Unit noraise) -> App

    Observes coalesced native state changes for every running window.

    App::permission

    source

    Grants one registered extension to a trusted source in one window.

    Extension registration alone never exposes renderer capabilities.

    App::run

    source
    async fn App::run(self : App) -> Unit raise AppRunError

    Runs the configured app through the native Proton runtime.

    App::run_or_abort

    source
    async fn App::run_or_abort(self : App) -> Unit

    Runs the configured app and aborts with the error message on failure.

    App::single_instance

    source
    fn App::single_instance(self : App, identifier : String) -> App

    Ensures only one operating-system process owns this application identity. Later processes forward their URL, document, or reopen activation and exit.

    App::size

    source
    fn App::size(self : App, width~ : Int, height~ : Int) -> App

    Sets the primary window size.

    App::title

    source
    fn App::title(self : App, title : String) -> App

    Sets the primary window title.

    App::titlebar_style

    source

    Sets whether web content remains below or extends beneath the native titlebar. Overlay rendering is currently implemented on macOS and Windows.

    App::window_lifecycle

    source
    fn[State] App::window_lifecycle(self : App, on_ready~ : async (WindowContext) -> State, on_close~ : async (State) -> Unit) -> App

    Adds a paired primary-window lifecycle hook.

    The ready state is passed to close. Completed hooks close in reverse order, including when a later ready hook fails.

    App::with_view

    source
    fn App::with_view(self : App, id : String, config : 
    ViewConfig    ) -> App

    Attaches a web contents view to the primary window at startup, the declarative counterpart of WindowHandle::add_view: the view is created with the window and can later be found through WindowHandle::view(id) or observed through App::on_view_event. Use the imperative WindowHandle::add_view for views whose lifetime is dynamic.

    ApplicationContext

    source

    Application-lifetime capabilities supplied to startup hooks.

    ApplicationContext::locale

    source

    Returns the immutable application locale selected at startup.

    ApplicationContext::preferred_languages

    source

    Returns the application's ordered language preferences.

    ApplicationContext::task_group

    source

    Returns the structured task group owned by this application.

    ApplicationContext::windows

    source

    Returns the window manager owned by this running application.

    BrowserHandle

    source
    pub struct BrowserHandle {
      id : String
      native_id : Int64
      load_browser_url : (String) -> Unit raise WindowSessionError
      load_browser_html : (String, String) -> Unit raise WindowSessionError
      eval_browser_script : (String) -> Unit raise WindowSessionError
      send_browser_command : (String, Int?) -> Unit raise WindowSessionError
    }

    BrowserHandle::back

    source
    fn BrowserHandle::back(self : BrowserHandle) -> Unit raise WindowSessionError

    BrowserHandle::cancel_download

    source
    fn BrowserHandle::cancel_download(self : BrowserHandle, download_id : Int) -> Unit raise WindowSessionError

    BrowserHandle::close_devtools

    source
    fn BrowserHandle::close_devtools(self : BrowserHandle) -> Unit raise WindowSessionError

    BrowserHandle::eval

    source
    fn BrowserHandle::eval(self : BrowserHandle, script : String) -> Unit raise WindowSessionError

    BrowserHandle::forward

    source
    fn BrowserHandle::forward(self : BrowserHandle) -> Unit raise WindowSessionError

    BrowserHandle::load_html

    source
    fn BrowserHandle::load_html(self : BrowserHandle, html : String, base_url : String) -> Unit raise WindowSessionError

    BrowserHandle::load_url

    source
    fn BrowserHandle::load_url(self : BrowserHandle, url : String) -> Unit raise WindowSessionError

    BrowserHandle::open_devtools

    source
    fn BrowserHandle::open_devtools(self : BrowserHandle) -> Unit raise WindowSessionError

    BrowserHandle::reload

    source
    fn BrowserHandle::reload(self : BrowserHandle, ignore_cache? : Bool) -> Unit raise WindowSessionError

    BrowserHandle::stop

    source
    fn BrowserHandle::stop(self : BrowserHandle) -> Unit raise WindowSessionError

    BrowserHandle::window_id

    source
    fn BrowserHandle::window_id(self : BrowserHandle) -> String

    BrowserPermissionDecision

    source
    pub(all) enum BrowserPermissionDecision {
      Allow
      Deny
    } derive(Eq, 
    Debug    )

    BrowserPermissionDecision::equal

    source

    BrowserPermissionDecision::not_equal

    source

    BrowserPermissionDecision::to_repr

    source

    CertificateError

    source
    pub(all) struct CertificateError {
      url : String
      error_code : Int
    } derive(Eq, 
    Debug    )

    CertificateError::equal

    source

    CertificateError::not_equal

    source
    fn CertificateError::not_equal(x : CertificateError, y : CertificateError) -> Bool

    CertificateError::to_repr

    source

    DownloadDecision

    source
    pub(all) enum DownloadDecision {
      Deny
      ShowSaveDialog
      SaveTo(String)
    } derive(Eq, 
    Debug    )

    DownloadDecision::equal

    source

    DownloadDecision::not_equal

    source
    fn DownloadDecision::not_equal(x : DownloadDecision, y : DownloadDecision) -> Bool

    DownloadDecision::to_repr

    source

    DownloadEvent

    source
    pub(all) struct DownloadEvent {
      id : Int
      state : String
      received_bytes : Int64
      total_bytes : Int64
      percent : Int
    } derive(Eq, 
    Debug    )

    DownloadEvent::equal

    source

    DownloadEvent::not_equal

    source
    fn DownloadEvent::not_equal(x : DownloadEvent, y : DownloadEvent) -> Bool

    DownloadEvent::to_repr

    source

    DownloadRequest

    source
    pub(all) struct DownloadRequest {
      id : Int
      url : String
      suggested_name : String
    } derive(Eq, 
    Debug    )

    DownloadRequest::equal

    source

    DownloadRequest::not_equal

    source
    fn DownloadRequest::not_equal(x : DownloadRequest, y : DownloadRequest) -> Bool

    DownloadRequest::to_repr

    source

    MediaPermissionRequest

    source
    pub(all) struct MediaPermissionRequest {
      origin : String
      permissions : Int
    } derive(Eq, 
    Debug    )

    MediaPermissionRequest::equal

    source

    MediaPermissionRequest::not_equal

    source

    MediaPermissionRequest::to_repr

    source

    pub(all) enum NavigationDecision {
      Allow
      Deny
    } derive(Eq, 
    Debug    )

    pub(all) struct NavigationRequest {
      url : String
      http_method : String
      user_gesture : Bool
      redirect : Bool
    } derive(Eq, 
    Debug    )

    fn NavigationRequest::not_equal(x : NavigationRequest, y : NavigationRequest) -> Bool

    PendingUpdate

    source
    pub struct PendingUpdate {
      version : String
      revision : UInt64
      notes_url : String?
      size : Int64
      channel : 
    UpdateChannel
      offer : 
    AvailableUpdate
    }

    An update the channel offered, and the means to take it.

    Being handed one means the manifest was signed by a trusted key, is fresh, and carries a revision newer than the installed one. Nothing has been downloaded.

    PendingUpdate::install

    source
    async fn PendingUpdate::install(self : PendingUpdate, on_progress? : async (Int64) -> Unit noraise) -> UpdateInstallOutcome

    Downloads this update and installs it over the running application.

    Downloaded chunks are written only to a private native stage while their size, digest, and signature are checked. The stage cannot be installed unless that authentication completes, and the expanded bundle's own code signature is checked before the installed application is touched. The application is not restarted — see restart.

    This is deliberately not something the framework does on its own. Checking without being asked is a reasonable default; installing without being asked changes the code someone is running, and only the application knows whether this is a moment when that is acceptable.

    PendingUpdate::notes_url

    source
    fn PendingUpdate::notes_url(self : PendingUpdate) -> String?

    Where the release notes for it live, when the manifest says.

    PendingUpdate::restart

    source
    fn PendingUpdate::restart(_self : PendingUpdate) -> Unit raise

    Starts the installed replacement. The caller should exit afterwards.

    Returning without an error means the system accepted the request, not that the new version is running: it decides that afterwards and does not report back.

    PendingUpdate::revision

    source
    fn PendingUpdate::revision(self : PendingUpdate) -> UInt64

    The signed monotonic release order.

    PendingUpdate::size

    source
    fn PendingUpdate::size(self : PendingUpdate) -> Int64

    How many bytes taking it will transfer.

    PendingUpdate::version

    source
    fn PendingUpdate::version(self : PendingUpdate) -> String

    The version on offer.

    PopupDecision

    source
    pub(all) enum PopupDecision {
      Deny
      OpenInCurrent
      OpenInWindow(String)
    } derive(Eq, 
    Debug    )

    PopupDecision::equal

    source

    PopupDecision::not_equal

    source
    fn PopupDecision::not_equal(x : PopupDecision, y : PopupDecision) -> Bool

    PopupDecision::to_repr

    source

    PopupRequest

    source
    pub(all) struct PopupRequest {
      url : String
      disposition : Int
      user_gesture : Bool
    } derive(Eq, 
    Debug    )

    PopupRequest::equal

    source

    PopupRequest::not_equal

    source
    fn PopupRequest::not_equal(x : PopupRequest, y : PopupRequest) -> Bool

    PopupRequest::to_repr

    source

    UpdateCheck

    source
    pub enum UpdateCheck {
      NotConfigured
      UpToDate
      Available(PendingUpdate)
    }

    What asking the channel concluded.

    UpdateInstallOutcome

    source
    pub enum UpdateInstallOutcome {
      Installed
      AlreadyInstalled
    } derive(Eq, 
    Debug    )

    What applying an update changed.

    UpdateInstallOutcome::equal

    source

    UpdateInstallOutcome::not_equal

    source

    UpdateInstallOutcome::to_repr

    source

    ViewEvent

    source
    pub(all) enum ViewEvent {
      LoadingChanged(is_loading~ : Bool)
      Navigated(url~ : String)
      TitleUpdated(title~ : String)
      LoadFailed(url~ : String, error_code~ : Int, error_text~ : String)
    } derive(Eq, 
    Debug    )

    An observed change to a running web contents view, following the Electron webContents lifecycle events.

    ViewEvent::equal

    source
    fn ViewEvent::equal(ViewEvent, ViewEvent) -> Bool

    ViewEvent::not_equal

    source
    fn ViewEvent::not_equal(x : ViewEvent, y : ViewEvent) -> Bool

    ViewEvent::to_repr

    source

    ViewHandle

    source
    pub struct ViewHandle {
      id : String
      native_id : Int64
      set_view_bounds : (Int, Int, Int, Int) -> Unit raise WindowSessionError
      set_view_visible : (Bool) -> Unit raise WindowSessionError
      set_view_z_order : (Int) -> Unit raise WindowSessionError
      load_view_url : (String) -> Unit raise WindowSessionError
      load_view_html : (String, String) -> Unit raise WindowSessionError
      eval_view_script : (String) -> Unit raise WindowSessionError
      send_view_command : (String, Int?) -> Unit raise WindowSessionError
      read_view_state : () -> 
    ViewState     raise WindowSessionError
      close_view : () -> Unit raise WindowSessionError
    }

    A non-owning reference to one concrete web contents view instance.

    Views follow the Electron WebContentsView model: each view is an independent web page hosted inside its owning window's content area with explicit top-left bounds, visibility, and z-order. The instance id prevents a stale handle from targeting a later view that reuses the same declarative id.

    ViewHandle::as_native_ref

    source

    Returns a low-level non-owning reference for native APIs.

    ViewHandle::back

    source
    fn ViewHandle::back(self : ViewHandle) -> Unit raise WindowSessionError

    ViewHandle::close

    source
    fn ViewHandle::close(self : ViewHandle) -> Unit raise WindowSessionError

    Removes and destroys the view, the Electron removeChildView equivalent.

    ViewHandle::close_devtools

    source
    fn ViewHandle::close_devtools(self : ViewHandle) -> Unit raise WindowSessionError

    ViewHandle::eval

    source
    fn ViewHandle::eval(self : ViewHandle, script : String) -> Unit raise WindowSessionError

    Executes JavaScript in the view's main frame without awaiting a result.

    ViewHandle::forward

    source
    fn ViewHandle::forward(self : ViewHandle) -> Unit raise WindowSessionError

    ViewHandle::id

    source
    fn ViewHandle::id(self : ViewHandle) -> String

    Returns the declarative id of this view.

    ViewHandle::load_html

    source
    fn ViewHandle::load_html(self : ViewHandle, html : String, base_url : String) -> Unit raise WindowSessionError

    Loads inline HTML into the view, served from base_url on the proton:// scheme, mirroring WindowHandle::load_html.

    ViewHandle::load_url

    source
    fn ViewHandle::load_url(self : ViewHandle, url : String) -> Unit raise WindowSessionError

    Navigates the view's page, the Electron view.webContents.loadURL equivalent.

    ViewHandle::open_devtools

    source
    fn ViewHandle::open_devtools(self : ViewHandle) -> Unit raise WindowSessionError

    ViewHandle::reload

    source
    fn ViewHandle::reload(self : ViewHandle, ignore_cache? : Bool) -> Unit raise WindowSessionError

    ViewHandle::set_bounds

    source
    fn ViewHandle::set_bounds(self : ViewHandle, x~ : Int, y~ : Int, width~ : Int, height~ : Int) -> Unit raise WindowSessionError

    Moves and resizes the view. x/y use a top-left origin in the owning window's content coordinate space, matching Electron's setBounds.

    ViewHandle::set_visible

    source
    fn ViewHandle::set_visible(self : ViewHandle, visible : Bool) -> Unit raise WindowSessionError

    ViewHandle::set_z_order

    source
    fn ViewHandle::set_z_order(self : ViewHandle, z_order : Int) -> Unit raise WindowSessionError

    Stacks the view relative to the window's other views; higher z_order renders above lower values.

    ViewHandle::state

    source

    Reads the current view state from the native runtime.

    ViewHandle::stop

    source
    fn ViewHandle::stop(self : ViewHandle) -> Unit raise WindowSessionError

    WindowCloseDecision

    source
    pub(all) enum WindowCloseDecision {
      Allow
      Deny
    } derive(Eq, 
    Debug    )

    The result of an asynchronous native close request.

    WindowCloseDecision::equal

    source

    WindowCloseDecision::not_equal

    source

    WindowCloseDecision::to_repr

    source

    WindowContext

    source

    Window-lifetime capabilities supplied to window startup hooks.

    WindowContext::events

    source

    Returns an event emitter bound to this window's active page.

    WindowContext::handle

    source

    Returns the session-controlled handle for this concrete window instance.

    WindowContext::id

    source
    fn WindowContext::id(self : WindowContext) -> String

    Returns the declarative id of this window. The primary window uses "main".

    WindowContext::locale

    source

    Returns the immutable application locale selected at startup.

    WindowContext::preferred_languages

    source

    Returns the application's ordered language preferences.

    WindowContext::task_group

    source

    Returns the structured task group owned by this window.

    WindowContext::window

    source

    Returns a non-owning reference to this window.

    WindowContext::windows

    source

    Returns the application window manager.

    WindowEvent

    source

    An observed change to a running native window.

    WindowEvent::equal

    source
    fn WindowEvent::equal(WindowEvent, WindowEvent) -> Bool

    WindowEvent::not_equal

    source
    fn WindowEvent::not_equal(x : WindowEvent, y : WindowEvent) -> Bool

    WindowEvent::to_repr

    source

    WindowEventEmitter

    source
    pub struct WindowEventEmitter {
      emit_event : async (
    ContractRoute    , String, Json) -> Unit noraise
    }

    A typed event destination bound to one explicit window.

    WindowEventEmitter::emit

    source
    async fn[Payload : ToJson] WindowEventEmitter::emit(self : WindowEventEmitter, event : 
    Event    [Payload], payload : Payload) -> Unit

    Emits a typed event to this emitter's window.

    WindowHandle

    source
    pub struct WindowHandle {
      id : String
      native_id : Int64
      show_window : () -> Unit raise WindowSessionError
      hide_window : () -> Unit raise WindowSessionError
      close_window : () -> Unit raise WindowSessionError
      focus_window : () -> Unit raise WindowSessionError
      set_window_title : (String) -> Unit raise WindowSessionError
      set_window_size : (Int, Int) -> Unit raise WindowSessionError
      minimize_window : () -> Unit raise WindowSessionError
      maximize_window : () -> Unit raise WindowSessionError
      restore_window : () -> Unit raise WindowSessionError
      set_window_fullscreen : (Bool) -> Unit raise WindowSessionError
      set_window_position : (Int, Int) -> Unit raise WindowSessionError
      set_window_always_on_top : (Bool) -> Unit raise WindowSessionError
      set_window_zoom_percent : (Int) -> Unit raise WindowSessionError
      read_window_state : () -> 
    WindowState     raise WindowSessionError
      browser : BrowserHandle
      add_view : (String, 
    ViewConfig    ) -> ViewHandle raise WindowSessionError
      remove_view : (String) -> Unit raise WindowSessionError
      list_views : () -> Array[ViewHandle]
      find_view : (String) -> ViewHandle?
    }

    A non-owning reference to one concrete window instance.

    The instance id prevents a stale handle from targeting a later window that reuses the same declarative id.

    WindowHandle::add_view

    source

    Adds a web contents view to this window, following the Electron WebContentsView model: the view renders its own page above the window's main browser content at explicit bounds. id is unique within the window and lets the session reject stale handles.

    WindowHandle::as_native_ref

    source

    Returns a low-level non-owning reference for APIs such as dialogs.

    WindowHandle::browser

    source
    fn WindowHandle::browser(self : WindowHandle) -> BrowserHandle

    WindowHandle::close

    source
    fn WindowHandle::close(self : WindowHandle) -> Unit raise WindowSessionError

    WindowHandle::focus

    source
    fn WindowHandle::focus(self : WindowHandle) -> Unit raise WindowSessionError

    WindowHandle::hide

    source
    fn WindowHandle::hide(self : WindowHandle) -> Unit raise WindowSessionError

    WindowHandle::id

    source
    fn WindowHandle::id(self : WindowHandle) -> String

    Returns the declarative id of this window.

    WindowHandle::maximize

    source
    fn WindowHandle::maximize(self : WindowHandle) -> Unit raise WindowSessionError

    WindowHandle::minimize

    source
    fn WindowHandle::minimize(self : WindowHandle) -> Unit raise WindowSessionError

    WindowHandle::remove_view

    source
    fn WindowHandle::remove_view(self : WindowHandle, id : String) -> Unit raise WindowSessionError

    Removes and destroys a web contents view previously added with add_view.

    WindowHandle::restore

    source
    fn WindowHandle::restore(self : WindowHandle) -> Unit raise WindowSessionError

    WindowHandle::set_always_on_top

    source
    fn WindowHandle::set_always_on_top(self : WindowHandle, always_on_top : Bool) -> Unit raise WindowSessionError

    WindowHandle::set_fullscreen

    source
    fn WindowHandle::set_fullscreen(self : WindowHandle, fullscreen : Bool) -> Unit raise WindowSessionError

    WindowHandle::set_position

    source
    fn WindowHandle::set_position(self : WindowHandle, x : Int, y : Int) -> Unit raise WindowSessionError

    WindowHandle::set_size

    source
    fn WindowHandle::set_size(self : WindowHandle, width : Int, height : Int) -> Unit raise WindowSessionError

    WindowHandle::set_title

    source
    fn WindowHandle::set_title(self : WindowHandle, title : String) -> Unit raise WindowSessionError

    WindowHandle::set_zoom_percent

    source
    fn WindowHandle::set_zoom_percent(self : WindowHandle, zoom_percent : Int) -> Unit raise WindowSessionError

    WindowHandle::show

    source
    fn WindowHandle::show(self : WindowHandle) -> Unit raise WindowSessionError

    WindowHandle::state

    source

    WindowHandle::view

    source
    fn WindowHandle::view(self : WindowHandle, id : String) -> ViewHandle?

    Returns the live view with the given declarative id, if one exists.

    WindowHandle::views

    source

    Lists the live web contents views of this window.

    WindowManager

    source
    pub struct WindowManager {
      open_window : async (String) -> WindowHandle raise WindowSessionError
      find_window : (String) -> WindowHandle?
    }

    Opens and locates windows declared by the application manifest.

    WindowManager::find

    source
    fn WindowManager::find(self : WindowManager, id : String) -> WindowHandle?

    Returns the active instance for a declared window id.

    WindowManager::open

    source
    async fn WindowManager::open(self : WindowManager, id : String) -> WindowHandle raise WindowSessionError

    Opens one declared window that is not currently active.

    abi_version

    source
    fn abi_version() -> Int

    app

    source
    fn app() -> App

    Creates an application from PROTON_CONFIG_PATH, proton.project.json in the current working directory, or code-only defaults.

    app_data_dir

    source
    fn app_data_dir(identifier : String) -> String raise AppPathError

    Resolves the stable per-application directory for native persistent data.

    The identifier should match the packaged bundle/application identifier. This function resolves the path but does not create the directory.

    asset

    source
    fn asset(title : String, path : String, width? : Int, height? : Int, debug? : Bool, resizable? : Bool) -> App

    Creates an inline asset application.

    check_for_update

    source
    async fn check_for_update() -> UpdateCheck

    Asks the configured channel whether a newer release is on offer.

    Available to the application at any time, not only at launch. Returns NotConfigured rather than UpToDate when there is no channel, because "nobody told us where to look" and "we looked and found nothing" are different answers and only one of them is worth showing a user.

    config

    source
    fn config(path : String) -> App

    Creates an application backed by a proton.project.json config file.

    The default proton.project.json path honors PROTON_CONFIG_PATH and packaged config discovery. Other paths are used exactly as provided.

    execute_process

    source

    file

    source
    fn file(title : String, path : String, width? : Int, height? : Int, debug? : Bool, resizable? : Bool) -> App

    Creates an inline file application.

    html

    source
    fn html(title : String, html : String, width? : Int, height? : Int, debug? : Bool, resizable? : Bool) -> App

    Creates an inline HTML application.

    last_error_message

    source
    fn last_error_message() -> String

    probe_runtime

    source

    resource_dir

    source
    fn resource_dir() -> String raise AppPathError

    Resolves the absolute application resource directory.

    This follows Proton's implicit project config discovery. In development it is the directory containing proton.project.json; in a packaged application it is the directory into which bundle.resources are copied, such as Contents/Resources in a macOS application bundle.

    runtime_info

    source

    runtime_info_json

    source
    fn runtime_info_json() -> String raise 
    NativeError

    screens

    source

    Enumerates all connected displays.

    Returns an array of ScreenInfo describing each monitor's bounds, work area, scale factor, and primary flag. The first entry is always the primary display. Raises UnsupportedNativeFeature when the native engine is not available.

    system_preferred_languages

    source

    Returns the operating system's valid preferred languages in preference order. Invalid platform entries are ignored.

    url

    source
    fn url(title : String, url : String, width? : Int, height? : Int, debug? : Bool, resizable? : Bool) -> App

    Creates an inline URL application.

    view

    source
    fn view(url : String, width~ : Int, height~ : Int, x? : Int, y? : Int, visible? : Bool, z_order? : Int, background_color? : String) -> 
    ViewConfig

    Creates a web contents view configuration for WindowHandle::add_view, following the Electron new WebContentsView(options) model: the view renders url inside its owning window's content area at explicit top-left bounds, stacked above the window's main page.

    Source Files

    Powered by MoonBit

    Site sourceReport issuePackagesBuild queueSkillsStatistics

    © 2026 mooncakes.io