🥮 mooncakes.io

    moonbit-community/proton_package/lib does not have a README file

    LinuxPackagingError

    source
    pub(all) suberror LinuxPackagingError {
      InvalidConfiguration(detail~ : String)
      ToolFailure(stage~ : String, detail~ : String)
    } derive(Eq, 
    Debug    )

    LinuxPackagingError::equal

    source

    LinuxPackagingError::message

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

    LinuxPackagingError::not_equal

    source

    LinuxPackagingError::to_repr

    source

    MacosSigningError

    source
    pub(all) suberror MacosSigningError {
      InvalidConfiguration(detail~ : String)
      ToolFailure(stage~ : String, detail~ : String)
      Verification(detail~ : String)
    } derive(Eq, 
    Debug    )

    MacosSigningError::equal

    source

    MacosSigningError::message

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

    MacosSigningError::not_equal

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

    MacosSigningError::to_repr

    source

    PackageFileSystemError

    source
    pub(all) suberror PackageFileSystemError {
      CreateDirectory(path~ : String, detail~ : String)
      Remove(path~ : String, detail~ : String)
      Copy(source~ : String, destination~ : String, detail~ : String)
      Read(path~ : String, detail~ : String)
      Write(path~ : String, detail~ : String)
      InvalidSource(path~ : String)
    } derive(Eq, 
    Debug    )

    PackageFileSystemError::equal

    source

    PackageFileSystemError::message

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

    PackageFileSystemError::not_equal

    source

    PackageFileSystemError::to_repr

    source

    PackagePlanError

    source
    pub(all) suberror PackagePlanError {
      InvalidProductName(reason~ : String)
      InvalidIdentifier(identifier~ : String, reason~ : String)
      InvalidUrlScheme(scheme~ : String, reason~ : String)
      InvalidVersion(version~ : String, reason~ : String)
      UnsupportedFormat(format~ : String)
      UnsupportedNsisInstallMode(value~ : String)
      DuplicateFormat(format~ : String)
      UnsupportedFormatForPlatform(format~ : String, platform~ : String)
      MissingExecutable(path~ : String)
      MissingInput(path~ : String)
      MissingIcon(path~ : String)
      InvalidPayload(detail~ : String)
    } derive(Eq, 
    Debug    )

    PackagePlanError::equal

    source

    PackagePlanError::message

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

    PackagePlanError::not_equal

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

    PackagePlanError::to_repr

    source

    PackageToolError

    source
    pub(all) suberror PackageToolError {
      Start(tool~ : String, detail~ : String)
      Exit(tool~ : String, code~ : Int, detail~ : String)
    } derive(Eq, 
    Debug    )

    PackageToolError::equal

    source

    PackageToolError::message

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

    PackageToolError::not_equal

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

    PackageToolError::to_repr

    source

    WindowsPackagingError

    source
    pub(all) suberror WindowsPackagingError {
      InvalidConfiguration(detail~ : String)
      MissingTarget(path~ : String)
      ToolFailure(stage~ : String, detail~ : String)
      Verification(detail~ : String)
    } derive(Eq, 
    Debug    )

    WindowsPackagingError::equal

    source

    WindowsPackagingError::message

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

    WindowsPackagingError::not_equal

    source

    WindowsPackagingError::to_repr

    source

    DocumentType

    source
    pub struct DocumentType {
      name : String
      extensions : Array[String]
      role : String
    } derive(Eq, 
    Debug    )

    A file association included in native application metadata.

    DocumentType::DocumentType

    source
    fn DocumentType::DocumentType(name : String, extensions : Array[String], role? : String) -> DocumentType

    DocumentType::equal

    source

    DocumentType::extensions

    source
    fn DocumentType::extensions(self : DocumentType) -> Array[String]

    DocumentType::name

    source
    fn DocumentType::name(self : DocumentType) -> String

    DocumentType::not_equal

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

    DocumentType::role

    source
    fn DocumentType::role(self : DocumentType) -> String

    DocumentType::to_repr

    source

    MacosPlistString

    source
    pub struct MacosPlistString {
      key : String
      value : String
    }

    An additional string property written to a generated macOS Info.plist.

    MacosPlistString::MacosPlistString

    source
    fn MacosPlistString::MacosPlistString(key : String, value : String) -> MacosPlistString

    MacosSignTarget

    source
    pub struct MacosSignTarget {
      path : String
      runtime_options : Bool
      entitlements : Bool
      identifier : String?
    }

    A nested macOS code object signed before the main executable and app.

    path is relative to the staged .app root. Array order is signing order, allowing callers to describe inside-out signing for nested frameworks.

    MacosSignTarget::MacosSignTarget

    source
    fn MacosSignTarget::MacosSignTarget(path : String, runtime_options? : Bool, entitlements? : Bool, identifier? : String) -> MacosSignTarget

    NsisInstallMode

    source
    pub(all) enum NsisInstallMode {
      CurrentUser
      PerMachine
      Both
    } derive(Eq, 
    Debug    )

    Windows NSIS installation scope. Both lets the installer user choose.

    NsisInstallMode::equal

    source

    NsisInstallMode::not_equal

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

    NsisInstallMode::parse

    source
    fn NsisInstallMode::parse(value : String) -> NsisInstallMode raise PackagePlanError

    NsisInstallMode::to_repr

    source

    NsisInstallMode::to_string

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

    PackageCustomization

    source
    pub struct PackageCustomization {
      windows_icon_embedded : Bool
      macos_plist_strings : Array[MacosPlistString]
      macos_sign_targets : Array[MacosSignTarget]
      windows_sign_targets : Array[String]
      windows_verify_targets : Array[String]
      linux_resources_path : String?
    }

    Host-specific additions to the otherwise portable package specification.

    PackageCustomization::PackageCustomization

    source
    fn PackageCustomization::PackageCustomization(windows_icon_embedded? : Bool, macos_plist_strings? : Array[MacosPlistString], macos_sign_targets? : Array[MacosSignTarget], windows_sign_targets? : Array[String], windows_verify_targets? : Array[String], linux_resources_path? : String) -> PackageCustomization

    Set windows_icon_embedded when the executable already contains its icon. Package icon paths remain available without modifying the executable again.

    PackageFormat

    source
    pub(all) enum PackageFormat {
      App
      Zip
      Dmg
      Nsis
      AppImage
    } derive(Eq, 
    Debug    )

    A host-native package artifact.

    PackageFormat::equal

    source

    PackageFormat::not_equal

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

    PackageFormat::parse

    source
    fn PackageFormat::parse(value : String) -> PackageFormat raise PackagePlanError

    PackageFormat::to_repr

    source

    PackageFormat::to_string

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

    PackageHost

    source
    pub(all) enum PackageHost {
      Macos
      Windows
      Linux
    } derive(Eq)

    The desktop platform supported by the current host-native packager.

    PackageHost::equal

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

    PackageHost::not_equal

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

    PackageLayout

    source
    pub struct PackageLayout {
      root : String
      executable : String
      resources : String
      libraries : String
      executables : String
    }

    Host-native directories for a package while it is being assembled.

    The paths are valid only for the duration of build_with. A caller may use them to add framework-specific files after the generic payloads have been copied and before signing and artifact creation begin.

    PackageLayout::executable

    source
    fn PackageLayout::executable(self : PackageLayout) -> String

    PackageLayout::executables

    source
    fn PackageLayout::executables(self : PackageLayout) -> String

    PackageLayout::libraries

    source
    fn PackageLayout::libraries(self : PackageLayout) -> String

    PackageLayout::resources

    source
    fn PackageLayout::resources(self : PackageLayout) -> String

    PackageLayout::root

    source
    fn PackageLayout::root(self : PackageLayout) -> String

    PackageSpec

    source
    pub struct PackageSpec {
      executable : String
      product_name : String
      identifier : String
      version : String
      formats : Array[PackageFormat]
      output : String
      payloads : Array[Payload]
      icons : Array[String]
      url_schemes : Array[String]
      document_types : Array[DocumentType]
      macos_minimum_system_version : String?
      nsis_install_mode : NsisInstallMode
      sign : Bool
      notarize : Bool
    } derive(Eq, 
    Debug    )

    Complete input to the host-native packager. macos_minimum_system_version sets the minimum supported macOS declaration. Omit it to leave LSMinimumSystemVersion unset. Binary compatibility is not inferred or validated by the packager.

    PackageSpec::PackageSpec

    source
    fn PackageSpec::PackageSpec(executable : String, product_name : String, identifier : String, version : String, formats : Array[PackageFormat], output : String, payloads? : Array[Payload], icons? : Array[String], url_schemes? : Array[String], document_types? : Array[DocumentType], macos_minimum_system_version? : String, nsis_install_mode? : NsisInstallMode, sign? : Bool, notarize? : Bool) -> PackageSpec

    PackageSpec::equal

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

    PackageSpec::not_equal

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

    PackageSpec::to_repr

    source

    Payload

    source
    pub struct Payload {
      source : String
      destination : String
      location : PayloadLocation
    } derive(Eq, 
    Debug    )

    A file or directory copied into the package.

    Payload::Payload

    source
    fn Payload::Payload(source : String, destination : String, location? : PayloadLocation) -> Payload

    Payload::equal

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

    Payload::not_equal

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

    Payload::to_repr

    source

    PayloadLocation

    source
    pub(all) enum PayloadLocation {
      Resources
      Libraries
      Executables
    } derive(Eq, 
    Debug    )

    The portable destination area for an additional package payload.

    PayloadLocation::equal

    source

    PayloadLocation::not_equal

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

    PayloadLocation::parse

    source
    fn PayloadLocation::parse(value : String) -> PayloadLocation raise PackagePlanError

    PayloadLocation::to_repr

    source

    build

    source
    async fn build(spec : PackageSpec) -> Array[String]

    Packages an already-built executable using the current host's native tools.

    build_with

    source
    async fn build_with(spec : PackageSpec, customization : PackageCustomization, prepare : async (PackageLayout) -> Unit) -> Array[String]

    Packages an executable and allows framework-specific staging before the package is signed and converted into its requested artifacts. The packager owns the staging directory: it copies the executable and payloads, calls prepare with their final layout, then signs and creates the artifacts. Preparation must finish all framework-specific writes before returning.

    current_package_host

    source
    async fn current_package_host() -> PackageHost

    Returns the desktop platform of the current packaging host.

    macos_versions

    source
    fn macos_versions(value : String) -> (String, String) raise PackagePlanError

    Resolves the macOS short and bundle versions from a package version.

    PROTON_MACOS_BUILD_NUMBER, when present, overrides the bundle version.

    resolve_package_formats

    source
    async fn resolve_package_formats(formats : Array[PackageFormat]) -> Array[PackageFormat]

    Resolves an explicit format list, or the current host's defaults when the list is empty, and rejects formats that the current host cannot build.

    validate_identifier

    source
    fn validate_identifier(value : String) -> String raise PackagePlanError

    Validates and trims a reverse-DNS application identifier.

    validate_package_version

    source
    fn validate_package_version(value : String) -> String raise PackagePlanError

    Validates and trims the version used by package metadata and paths.

    validate_product_name

    source
    fn validate_product_name(value : String) -> String raise PackagePlanError

    Validates and trims an application display name for native package metadata.

    Source Files

    Powered by MoonBit

    Site sourceReport issuePackagesBuild queueSkillsStatistics

    © 2026 mooncakes.io