microsoft-webui-desktop 3.0.0

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT license.

//! Native desktop SDK for WebUI applications.
//!
//! Bundle loading, rendering, and frame configuration are available without
//! native dependencies. Enable `application-ipc` for application IPC,
//! `native` for the platform webview, `source` for
//! development compilation, and `cli` for the `webui-desktop` tooling binary.
//! Enable `packaging` to lay out an already-compiled host without source compilation.
//! Enable `verified-update` for host-only, staged-file byte integrity checks.
//! Enable `startup-failure` for an explicit host-only pre-frame error alert.

#[cfg(test)]
extern crate self as webui_desktop;

#[cfg(all(test, feature = "application-ipc"))]
#[path = "../tests/support/echo.rs"]
mod ipc_test_support;

#[cfg(all(test, feature = "application-ipc"))]
#[path = "../tests/ipc_contract.rs"]
mod ipc_contract_tests;

mod app;
#[cfg(any(feature = "native", test))]
mod app_identity;
mod asset_file;
#[cfg(any(all(windows, feature = "native"), test))]
mod browser_profile;
mod bundle;
#[cfg(feature = "native-capture")]
mod capture;
#[cfg(feature = "native-clipboard")]
mod clipboard;
#[cfg(all(feature = "native", feature = "application-ipc"))]
mod document;
mod error;
mod event;
#[cfg(any(feature = "native", test))]
mod execution;
mod frame;
#[cfg(feature = "local-server")]
mod frame_policy;
mod hydration;
#[cfg(any(test, all(feature = "native", target_os = "macos")))]
mod icon_path;
#[cfg(feature = "application-ipc")]
pub mod ipc;
#[cfg(test)]
#[path = "../runtime/ipc_asset_build.rs"]
mod ipc_asset_build_tests;
#[cfg(feature = "application-ipc")]
mod ipc_assets;
#[cfg(feature = "local-server")]
mod local_server;
#[cfg(feature = "native-dialogs")]
mod native_dialogs;
#[cfg(all(feature = "native", feature = "application-ipc"))]
mod native_ipc;
#[cfg(feature = "native-services")]
mod native_services;
#[cfg(all(
    feature = "native",
    any(
        feature = "application-ipc",
        target_os = "macos",
        target_os = "windows"
    )
))]
mod native_tasks;
#[cfg(feature = "native-services")]
mod native_theme;
mod navigation;
#[cfg(any(feature = "source", feature = "packaging"))]
mod package;
#[cfg(feature = "packaging")]
mod package_precompiled;
mod path;
mod protocol;
mod response_content;
mod routes;
mod runtime;
#[cfg(feature = "startup-failure")]
mod startup_failure;
#[cfg(feature = "verified-update")]
pub mod verified_update;
mod window;
mod window_state;

#[cfg(all(feature = "native", target_os = "linux"))]
#[allow(unsafe_code)]
pub mod linux;
#[cfg(all(feature = "native", target_os = "macos"))]
#[allow(unsafe_code)]
pub mod macos;
#[cfg(all(feature = "native", target_os = "windows"))]
#[allow(unsafe_code)]
pub mod windows;

#[cfg(feature = "native")]
pub use app::run_packaged_app;
pub use app::{DesktopApp, DesktopAppBuilder};
#[cfg(feature = "source")]
pub use bundle::{build_desktop_bundle, DesktopBundleOptions};
pub use bundle::{
    BundleAsset, BundleIntegrity, DesktopBundleManifest, DesktopMenu, DesktopMenuItem,
    DesktopPackageTarget, DesktopShellConfig, TrayConfig,
};
#[cfg(feature = "native-capture")]
pub use capture::{
    CaptureError, CaptureOptions, CaptureRequest, CapturedContent, CapturedContentChunk,
    MAX_WEB_CAPTURE_CHUNK_BYTES, MAX_WEB_CAPTURE_HEIGHT, MAX_WEB_CAPTURE_PNG_BYTES,
    MAX_WEB_CAPTURE_RASTER_BYTES, MAX_WEB_CAPTURE_WIDTH,
};
#[cfg(feature = "native-clipboard")]
pub use clipboard::{ClipboardError, ClipboardRequest};
pub use error::{DesktopError, Result, WebsiteDataError};
pub use event::{
    DesktopEvent, DesktopHostMessage, DesktopHostMessageError, EventHandler, EventJavascriptError,
    EventRegistrationError, EventRegistry, EventResponse, EventSubscription, WindowCommand,
    WindowCommandError, WindowHandle, WindowId, DRAG_REGION_SCRIPT, MAX_EVENT_HANDLERS,
    MAX_HOST_MESSAGE_BYTES, MAX_QUEUED_WINDOW_COMMANDS, MAX_QUEUED_WINDOW_TITLE_BYTES,
    MAX_WINDOW_TITLE_BYTES,
};
pub use frame::{
    find_packaged_resources_dir, run_frame_with, validate_frame_capabilities, DesktopFrame,
    DesktopFrameBackend, DesktopFrameCapabilities,
};
#[cfg(feature = "native")]
pub use frame::{run_frame, run_runtime, PlatformFrameBackend};
#[cfg(feature = "local-server")]
pub use frame_policy::{FrameGrant, FramePolicyHandle, HttpFrameOrigin};
#[cfg(feature = "application-ipc")]
pub use ipc::{IpcRegistry, DEFAULT_MAX_IPC_PAYLOAD_BYTES, IPC_VERSION};
#[cfg(feature = "local-server")]
pub use local_server::bind_owned_local_server;
#[cfg(all(
    feature = "local-server",
    feature = "application-ipc",
    any(target_os = "macos", target_os = "windows", target_os = "linux")
))]
pub use local_server::{local_ipc_runtime_asset, LOCAL_IPC_RUNTIME_PATH};
#[cfg(feature = "local-server")]
pub use local_server::{
    run_local_server_frame, HostCloseError, HostLifetime, HostLifetimeOwner, LocalServerAppBuilder,
    LocalServerFrame, LocalServerOptions, LoopbackOrigin,
};
#[cfg(feature = "native-url-activation")]
pub use local_server::{
    UrlActivation, UrlActivationRegistrationError, MAX_URL_ACTIVATIONS_PER_BATCH,
    MAX_URL_ACTIVATION_BYTES,
};
#[cfg(feature = "native-dialogs")]
pub use native_dialogs::{
    ConfirmDialog, DialogError, DialogOutcome, DialogRequest, ErrorDialog, MAX_DIALOG_LABEL_BYTES,
    MAX_DIALOG_MESSAGE_BYTES, MAX_DIALOG_TITLE_BYTES,
};
#[cfg(feature = "native-services")]
pub use native_services::{
    ContentGeometry, GeometryRequest, NativeOpen, NativeServiceError, NativeServices,
    ScreenRectPoints, MAX_NATIVE_DOCUMENT_PATH_BYTES, MAX_NATIVE_URL_BYTES,
};
#[cfg(feature = "native-picker")]
pub use native_services::{
    DirectoryPick, DirectoryPickerOptions, DirectorySelection, MAX_DIRECTORY_PICKER_TITLE_BYTES,
};
#[cfg(feature = "native-services")]
pub use native_theme::{ThemeMode, ThemeRequest, ThemeState};
pub use navigation::is_allowed_navigation_url;
#[cfg(feature = "source")]
pub use package::{package_desktop_bundle, DesktopPackageOptions, DesktopPackageResult};
#[cfg(feature = "packaging")]
pub use package_precompiled::{
    package_precompiled_host, PrecompiledHostOptions, PrecompiledPackageResult,
    PrecompiledResource, ResourceKind,
};
#[cfg(feature = "application-ipc")]
pub use protocol::IPC_ENDPOINT;
pub use protocol::{
    DesktopHttpMethod, DesktopProtocolRequest, DesktopProtocolResponse, DesktopResponseBody,
    DesktopResponseLease, DEFAULT_MAX_ASSET_BYTES, DEFAULT_MAX_REQUEST_BYTES,
};
pub use response_content::{DesktopResponseContent, DesktopResponseFile};
pub use routes::{ApiContext, ApiRouteRegistry, RouteContext, RouteStateRegistry};
#[cfg(feature = "source")]
pub use runtime::DesktopSourceConfig;
pub use runtime::{DesktopBundleConfig, DesktopRuntime};
#[cfg(feature = "startup-failure")]
pub use startup_failure::{
    present_startup_failure, StartupFailure, StartupFailureError, StartupPresentationError,
    MAX_STARTUP_HELP_BYTES, MAX_STARTUP_SUMMARY_BYTES, MAX_STARTUP_TITLE_BYTES,
};
pub use window::{
    apply_window_css, window_css_block, window_css_block_with_nonce, CaptionButtonSize,
    DesktopPlatform, Rgba, RgbaParseError, TitlebarStyle, WindowCssNonceError, WindowEffect,
    WindowInsets, WindowOptions,
};
pub use window_state::{DisplayBounds, WindowState, WindowStateError, WindowStateStore};

#[cfg(feature = "source")]
pub use webui::{
    BuildOptions, CssStrategy, DomStrategy, LegalComments, Plugin, DEFAULT_CSS_FILE_NAME_TEMPLATE,
};