@gtkx/ffi 0.5.2 → 0.6.1

package/dist/generated/appstream/enums.d.ts

@@ -0,0 +1,749 @@
+/** The kind of the agreement. */
+export declare enum AgreementKind {
+    /** Unknown value */
+    UNKNOWN = 0,
+    /** A generic agreement without a specific type */
+    GENERIC = 1,
+    /** An End User License Agreement */
+    EULA = 2,
+    /** A privacy agreement, typically a GDPR statement */
+    PRIVACY = 3
+}
+/** The artifact type. */
+export declare enum ArtifactKind {
+    /** Type invalid or not known */
+    UNKNOWN = 0,
+    /** The artifact describes software sources. */
+    SOURCE = 1,
+    /** The artifact describes a binary distribution of the component. */
+    BINARY = 2
+}
+/** The bundle type. */
+export declare enum BundleKind {
+    /** Type invalid or not known */
+    UNKNOWN = 0,
+    /** A native package (currently not used) */
+    PACKAGE = 1,
+    /** A Limba bundle */
+    LIMBA = 2,
+    /** A Flatpak bundle */
+    FLATPAK = 3,
+    /** An AppImageKit bundle */
+    APPIMAGE = 4,
+    /** A Snap/Snappy bundle */
+    SNAP = 5,
+    /** A (maybe compressed) tarball. */
+    TARBALL = 6,
+    /** Cabinet firmware deployment */
+    CABINET = 7,
+    /** A Linglong bundle */
+    LINGLONG = 8,
+    /** A systemd-sysupdate bundle */
+    SYSUPDATE = 9
+}
+/** The type of chassis a computing device is built into. */
+export declare enum ChassisKind {
+    /** Unknown chassis. */
+    UNKNOWN = 0,
+    /** A desktop/workstation */
+    DESKTOP = 1,
+    /** A mobile computer with a bigger screen / laptop */
+    LAPTOP = 2,
+    /** A server, often without GUI */
+    SERVER = 3,
+    /** A tablet with touch as primary input method */
+    TABLET = 4,
+    /** A smaller touch-input device, like a smartphone */
+    HANDSET = 5
+}
+/** Result of a check operation. */
+export declare enum CheckResult {
+    /** The check failed. */
+    ERROR = 0,
+    /** The outcome could not be determined. */
+    UNKNOWN = 1,
+    /** False/No */
+    FALSE = 2,
+    /** True/Yes */
+    TRUE = 3
+}
+/** Checksums supported by #AsRelease */
+export declare enum ChecksumKind {
+    /** No checksum */
+    NONE = 0,
+    /** SHA1 checksum */
+    SHA1 = 1,
+    /** SHA256 checksum */
+    SHA256 = 2,
+    /** SHA512 checksum */
+    SHA512 = 3,
+    /** BLAKE2 checksum */
+    BLAKE2B = 4,
+    /** BLAKE3 checksum */
+    BLAKE3 = 5
+}
+/** A branding color type. */
+export declare enum ColorKind {
+    /** Color type invalid or not known */
+    UNKNOWN = 0,
+    /** Primary accent color */
+    PRIMARY = 1
+}
+/** A color scheme type. */
+export declare enum ColorSchemeKind {
+    /** Color scheme invalid or not known */
+    UNKNOWN = 0,
+    /** A light color scheme */
+    LIGHT = 1,
+    /** A dark color scheme */
+    DARK = 2
+}
+/** The type of an #AsComponent. */
+export declare enum ComponentKind {
+    /** Type invalid or not known */
+    UNKNOWN = 0,
+    /** A generic (= without specialized type) component */
+    GENERIC = 1,
+    /** An application with a .desktop-file */
+    DESKTOP_APP = 2,
+    /** A console application */
+    CONSOLE_APP = 3,
+    /** A web application */
+    WEB_APP = 4,
+    /** A system service launched by the init system */
+    SERVICE = 5,
+    /** An extension of existing software, which does not run standalone */
+    ADDON = 6,
+    /** An application runtime platform */
+    RUNTIME = 7,
+    /** A font */
+    FONT = 8,
+    /** A multimedia codec */
+    CODEC = 9,
+    /** An input-method provider */
+    INPUT_METHOD = 10,
+    /** A computer operating system */
+    OPERATING_SYSTEM = 11,
+    /** Firmware */
+    FIRMWARE = 12,
+    /** A driver */
+    DRIVER = 13,
+    /** Software localization (usually l10n resources) */
+    LOCALIZATION = 14,
+    /** A remote software or data source */
+    REPOSITORY = 15,
+    /** An icon theme following the XDG specification */
+    ICON_THEME = 16
+}
+/** Scope of the #AsComponent (system-wide or user-scope) */
+export declare enum ComponentScope {
+    /** Unknown scope */
+    UNKNOWN = 0,
+    /** System scope */
+    SYSTEM = 1,
+    /** User scope */
+    USER = 2
+}
+/** A content rating system for a particular territory. */
+export declare enum ContentRatingSystem {
+    /** Unknown ratings system */
+    UNKNOWN = 0,
+    /** INCAA */
+    INCAA = 1,
+    /** ACB */
+    ACB = 2,
+    /** DJCTQ */
+    DJCTQ = 3,
+    /** GSRR */
+    GSRR = 4,
+    /** PEGI */
+    PEGI = 5,
+    /** KAVI */
+    KAVI = 6,
+    /** USK */
+    USK = 7,
+    /** ESRA */
+    ESRA = 8,
+    /** CERO */
+    CERO = 9,
+    /** OFLCNZ */
+    OFLCNZ = 10,
+    /** Russia */
+    RUSSIA = 11,
+    /** MDA */
+    MDA = 12,
+    /** GRAC */
+    GRAC = 13,
+    /** ESRB */
+    ESRB = 14,
+    /** IARC */
+    IARC = 15
+}
+/** The specified level of an content_rating rating ID. */
+export declare enum ContentRatingValue {
+    /** Unknown value */
+    UNKNOWN = 0,
+    /** None */
+    NONE = 1,
+    /** A small amount */
+    MILD = 2,
+    /** A moderate amount */
+    MODERATE = 3,
+    /** An intense amount */
+    INTENSE = 4
+}
+/** Kind of an input method for users to control software */
+export declare enum ControlKind {
+    /** Unknown kind */
+    UNKNOWN = 0,
+    /** Mouse/cursors/other precision pointing device */
+    POINTING = 1,
+    /** Keyboard input */
+    KEYBOARD = 2,
+    /** Console / command-line interface */
+    CONSOLE = 3,
+    /** Touch input */
+    TOUCH = 4,
+    /** Gamepad input (any game controller with wheels/buttons/joysticks) */
+    GAMEPAD = 5,
+    /** Control via voice recognition/activation */
+    VOICE = 6,
+    /** Computer vision / visual object and sign detection */
+    VISION = 7,
+    /** Input via a television remote */
+    TV_REMOTE = 8,
+    /** Graphics tablet input */
+    TABLET = 9
+}
+/** Side a display_length requirement is for. */
+export declare enum DisplaySideKind {
+    /** Unknown */
+    UNKNOWN = 0,
+    /** Shortest side of the display rectangle. */
+    SHORTEST = 1,
+    /** Longest side of the display rectangle. */
+    LONGEST = 2
+}
+/** Format of the AppStream metadata. */
+export declare enum FormatKind {
+    /** Unknown metadata format. */
+    UNKNOWN = 0,
+    /** AppStream XML metadata. */
+    XML = 1,
+    /** AppStream YAML (DEP-11) metadata. */
+    YAML = 2,
+    /** XDG Desktop Entry data. */
+    DESKTOP_ENTRY = 3
+}
+/**
+ * There are a few differences between AppStream's metainfo files (shipped by upstream projects)
+ * and the catalog metadata (shipped by distributors).
+ * The data source kind indicates which style we should process.
+ * Usually you do not want to set this explicitly.
+ */
+export declare enum FormatStyle {
+    /** The format style is unknown. */
+    UNKNOWN = 0,
+    /** Parse AppStream upstream metadata (metainfo files) */
+    METAINFO = 1,
+    /** Parse AppStream metadata catalog (shipped by software distributors) */
+    CATALOG = 2
+}
+/** Format version / API level of the AppStream metadata. */
+export declare enum FormatVersion {
+    /** Unknown format version */
+    UNKNOWN = 0,
+    V1_0 = 1
+}
+/** The icon type. */
+export declare enum IconKind {
+    /** Unknown icon kind */
+    UNKNOWN = 0,
+    /** Stock icon name */
+    STOCK = 1,
+    /** Icon in the internal caches */
+    CACHED = 2,
+    /** Local icon name */
+    LOCAL = 3,
+    /** Remote icon URL */
+    REMOTE = 4
+}
+/** The image type. */
+export declare enum ImageKind {
+    /** Type invalid or not known */
+    UNKNOWN = 0,
+    /** The source image at full resolution */
+    SOURCE = 1,
+    /** A thumbnail at reduced resolution */
+    THUMBNAIL = 2
+}
+/**
+ * Different internet connectivity requirements or recommendations for an
+ * application.
+ */
+export declare enum InternetKind {
+    /** Unknown */
+    UNKNOWN = 0,
+    /** Always requires/recommends internet */
+    ALWAYS = 1,
+    /** Application is offline-only */
+    OFFLINE_ONLY = 2,
+    /** Requires/Recommends internet on first run only */
+    FIRST_RUN = 3
+}
+/** Checksums supported by #AsRelease */
+export declare enum IssueKind {
+    /** Unknown issue type */
+    UNKNOWN = 0,
+    /** Generic issue type */
+    GENERIC = 1,
+    /** Common Vulnerabilities and Exposures issue */
+    CVE = 2
+}
+/** The severity of an issue found by #AsValidator */
+export declare enum IssueSeverity {
+    /** The severity is unknown. */
+    UNKNOWN = 0,
+    /** Pedantic information about ways to improve the data, but could also be ignored. */
+    PEDANTIC = 1,
+    /**
+     * Non-essential information on how to improve metadata, no immediate action needed.
+     */
+    INFO = 2,
+    /** Something metadata issue which should be fixed as soon as possible. */
+    WARNING = 3,
+    /** There is a serious, fatal error in your metadata */
+    ERROR = 4
+}
+/** Type of launch system the entries belong to. */
+export declare enum LaunchableKind {
+    /** Unknown kind */
+    UNKNOWN = 0,
+    /** Launch by desktop-id */
+    DESKTOP_ID = 1,
+    /** A systemd/SysV-init service name */
+    SERVICE = 2,
+    /** A Cockpit manifest / package name */
+    COCKPIT_MANIFEST = 3,
+    /** A web HTTPS URL to launch a web application from */
+    URL = 4
+}
+/** Text markup types. */
+export declare enum MarkupKind {
+    /** Unknown markup. */
+    UNKNOWN = 0,
+    /** XML markup. */
+    XML = 1,
+    /** Simple text with unicode symbols. */
+    TEXT = 2,
+    /** Markdown */
+    MARKDOWN = 3
+}
+/**
+ * Defines how #AsComponent data should be merged if the component is
+ * set for merge.
+ */
+export declare enum MergeKind {
+    /** No merge is happening. */
+    NONE = 0,
+    /** Merge replacing data of target. */
+    REPLACE = 1,
+    /** Merge appending data to target. */
+    APPEND = 2,
+    /** Remove the entire component if it matches. */
+    REMOVE_COMPONENT = 3
+}
+/** A metadata processing error. */
+export declare enum MetadataError {
+    /** Generic failure. */
+    FAILED = 0,
+    /** Unable to parse the metadata file. */
+    PARSE = 1,
+    /** Expected catalog metadata but got metainfo metadata, or vice versa. */
+    FORMAT_UNEXPECTED = 2,
+    /** We expected a component in the pool, but couldn't find one. */
+    NO_COMPONENT = 3,
+    /** A essential value is missing in the source document. */
+    VALUE_MISSING = 4
+}
+/** The flags used when installing and removing metadata files. */
+export declare enum MetadataLocation {
+    /** An unknown/invalid location. */
+    UNKNOWN = 0,
+    /** Installed by the vendor, shared */
+    SHARED = 1,
+    /** Installed as metadata into /var/lib, shared */
+    STATE = 2,
+    /** Installed as metadata into /var/cache, shared */
+    CACHE = 3,
+    /** Installed for the current user */
+    USER = 4
+}
+/** A metadata pool error. */
+export declare enum PoolError {
+    /** Generic failure */
+    FAILED = 0,
+    /** The pool was loaded, but we had to ignore some metadata. */
+    INCOMPLETE = 1,
+    /**
+     * An AppStream-ID collision occured (a component with that ID already existed in the pool)
+     */
+    COLLISION = 2,
+    /** Unable to write to *any* cache file (not even tmpfs writes worked) */
+    CACHE_WRITE_FAILED = 3,
+    /** The disk cache was broken and we could not automatically recover. */
+    CACHE_DAMAGED = 4
+}
+/** Type of the public interface components can provide. */
+export declare enum ProvidedKind {
+    /** Unknown kind */
+    UNKNOWN = 0,
+    /** A shared library */
+    LIBRARY = 1,
+    /** A binary installed into a directory in PATH */
+    BINARY = 2,
+    /** Provides a handler for a mimetype */
+    MEDIATYPE = 3,
+    /** A font */
+    FONT = 4,
+    /** A modalias */
+    MODALIAS = 5,
+    /** A Python 3 module */
+    PYTHON = 6,
+    /** A DBus service name on the system bus. */
+    DBUS_SYSTEM = 7,
+    /** A DBus service name on the user/session bus. */
+    DBUS_USER = 8,
+    /** Firmware flashed at runtime. */
+    FIRMWARE_RUNTIME = 9,
+    /** Firmware flashed permanently to the device. */
+    FIRMWARE_FLASHED = 10,
+    /** An AppStream component */
+    ID = 11
+}
+/** A reference type. */
+export declare enum ReferenceKind {
+    /** Unknown reference kind. */
+    UNKNOWN = 0,
+    /** Digital Object Identifier */
+    DOI = 1,
+    /** Web URL to a Citation File Format file */
+    CITATION_CFF = 2,
+    /** A generic registry. */
+    REGISTRY = 3
+}
+/** The relational comparison type. */
+export declare enum RelationCompare {
+    /** Comparison predicate invalid or not known */
+    UNKNOWN = 0,
+    /** Equal to */
+    EQ = 1,
+    /** Not equal to */
+    NE = 2,
+    /** Less than */
+    LT = 3,
+    /** Greater than */
+    GT = 4,
+    /** Less than or equal to */
+    LE = 5,
+    /** Greater than or equal to */
+    GE = 6
+}
+/** The error type. */
+export declare enum RelationError {
+    /** Generic failure */
+    FAILED = 0,
+    /** A metadata value was bad. */
+    BAD_VALUE = 1,
+    /** Some check was not (yet) implemented. */
+    NOT_IMPLEMENTED = 2
+}
+/** Type of the item an #AsRelation is for. */
+export declare enum RelationItemKind {
+    /** Unknown kind */
+    UNKNOWN = 0,
+    /** A component ID */
+    ID = 1,
+    /** A hardware modalias */
+    MODALIAS = 2,
+    /** An operating system kernel (like Linux) */
+    KERNEL = 3,
+    /** A system RAM requirement */
+    MEMORY = 4,
+    /** A device firmware requirement (used by fwupd) */
+    FIRMWARE = 5,
+    /** An input method for users to control software */
+    CONTROL = 6,
+    /** Display edge length */
+    DISPLAY_LENGTH = 7,
+    /** A Computer Hardware ID (CHID) to depend on system hardware */
+    HARDWARE = 8,
+    /** Internet connectivity (Since: 0.15.5) */
+    INTERNET = 9
+}
+/** Type of a component's relation to other items. */
+export declare enum RelationKind {
+    /** Unknown kind */
+    UNKNOWN = 0,
+    /** The referenced item is required by the component */
+    REQUIRES = 1,
+    /** The referenced item is recommended */
+    RECOMMENDS = 2,
+    /** The referenced item is supported */
+    SUPPORTS = 3
+}
+/** Status of a relation check result. */
+export declare enum RelationStatus {
+    /** Unknown status. */
+    UNKNOWN = 0,
+    /** An error occured and the status could not be checked. */
+    ERROR = 1,
+    /** The relation is not satisfied. */
+    NOT_SATISFIED = 2,
+    /** The relation is satisfied. */
+    SATISFIED = 3
+}
+/** The release kind. */
+export declare enum ReleaseKind {
+    /** Unknown release type */
+    UNKNOWN = 0,
+    /** A stable release for end-users */
+    STABLE = 1,
+    /** A development release or pre-release for testing */
+    DEVELOPMENT = 2,
+    /** A snapshot of a software being worked on */
+    SNAPSHOT = 3
+}
+/** The kind of a releases block. */
+export declare enum ReleaseListKind {
+    /** Unknown releases type */
+    UNKNOWN = 0,
+    /** Release info is embedded in metainfo file */
+    EMBEDDED = 1,
+    /** Release info is split to a separate file */
+    EXTERNAL = 2
+}
+/**
+ * `AS_RELEASE_URL_KIND_UNKNOWN` 	Unknown release web URL type
+ * The release URL kinds.
+ */
+export declare enum ReleaseUrlKind {
+    UNKNOWN = 0,
+    /** Weblink to detailed release notes. */
+    DETAILS = 1
+}
+/** The screenshot type. */
+export declare enum ScreenshotKind {
+    /** Type invalid or not known */
+    UNKNOWN = 0,
+    /** The primary screenshot to show by default */
+    DEFAULT = 1,
+    /** Optional screenshot */
+    EXTRA = 2
+}
+/** The media kind contained in this screenshot. */
+export declare enum ScreenshotMediaKind {
+    /** Media kind is unknown */
+    UNKNOWN = 0,
+    /** The screenshot contains images */
+    IMAGE = 1,
+    /** The screenshot contains videos */
+    VIDEO = 2
+}
+/** The artifact size kind. */
+export declare enum SizeKind {
+    /** Unknown size */
+    UNKNOWN = 0,
+    /** Size of download of component */
+    DOWNLOAD = 1,
+    /** Size of installed component */
+    INSTALLED = 2
+}
+/** The suggested type. */
+export declare enum SuggestedKind {
+    /** Unknown suggested kind */
+    UNKNOWN = 0,
+    /** Suggestions provided by the upstream project. */
+    UPSTREAM = 1,
+    /** Suggestions provided by automatic heuristics. */
+    HEURISTIC = 2
+}
+/** The error type. */
+export declare enum SystemInfoError {
+    /** Generic failure */
+    FAILED = 0,
+    /** Information was not found. */
+    NOT_FOUND = 1
+}
+/** The translation type. */
+export declare enum TranslationKind {
+    /** Type invalid or not known */
+    UNKNOWN = 0,
+    /** Gettext translation domain */
+    GETTEXT = 1,
+    /** Qt translation domain */
+    QT = 2
+}
+/** The urgency of an #AsRelease */
+export declare enum UrgencyKind {
+    /** Urgency is unknown or not set */
+    UNKNOWN = 0,
+    /** Low urgency */
+    LOW = 1,
+    /** Medium urgency */
+    MEDIUM = 2,
+    /** High urgency */
+    HIGH = 3,
+    /** Critical urgency */
+    CRITICAL = 4
+}
+/** The URL type. */
+export declare enum UrlKind {
+    /** Type invalid or not known */
+    UNKNOWN = 0,
+    /** Project homepage */
+    HOMEPAGE = 1,
+    /** Bugtracker */
+    BUGTRACKER = 2,
+    /** FAQ page */
+    FAQ = 3,
+    /** Help manual */
+    HELP = 4,
+    /** Page with information about how to donate to the project */
+    DONATION = 5,
+    /** Page with instructions on how to translate the project / submit translations. */
+    TRANSLATE = 6,
+    /** Contact the developers */
+    CONTACT = 7,
+    /** Browse the source code */
+    VCS_BROWSER = 8,
+    /** Help developing */
+    CONTRIBUTE = 9
+}
+/** The error type. */
+export declare enum UtilsError {
+    /** Generic failure */
+    FAILED = 0
+}
+/** The error type. */
+export declare enum ValidatorError {
+    /** Generic failure */
+    FAILED = 0,
+    /** The issue override was not accepted. */
+    INVALID_OVERRIDE = 1,
+    /** The filename was invalid. */
+    INVALID_FILENAME = 2
+}
+/** Supported video codecs. */
+export declare enum VideoCodecKind {
+    /** Unknown video codec */
+    UNKNOWN = 0,
+    /** The VP9 video codec */
+    VP9 = 1,
+    /** The AV1 video codec */
+    AV1 = 2
+}
+/** Supported video codecs. */
+export declare enum VideoContainerKind {
+    /** Unknown video container */
+    UNKNOWN = 0,
+    /** The Matroska video (MKV) container */
+    MKV = 1,
+    /** The WebM video container */
+    WEBM = 2
+}
+/** Flags on how caching should be used. */
+export declare enum CacheFlags {
+    /** No flags. */
+    NONE = 0,
+    /** Create an user-specific metadata cache. */
+    USE_USER = 1,
+    /** Use and - if possible - update the system metadata cache. */
+    USE_SYSTEM = 2,
+    /** Don't clear the cache when opening it. */
+    NO_CLEAR = 4,
+    /** Refresh the system cache that is shared between applications. */
+    REFRESH_SYSTEM = 8
+}
+/** Flags controlling the component box behavior. */
+export declare enum ComponentBoxFlags {
+    /** No flags. */
+    NONE = 0,
+    /** Only perform the most basic verification. */
+    NO_CHECKS = 1
+}
+/** The flags used when matching unique IDs. */
+export declare enum DataIdMatchFlags {
+    /** No flags set */
+    NONE = 0,
+    /** Scope, e.g. a #AsComponentScope */
+    SCOPE = 1,
+    /** Bundle kind, e.g. a #AsBundleKind */
+    BUNDLE_KIND = 2,
+    /** Origin */
+    ORIGIN = 4,
+    /** Component AppStream ID */
+    ID = 8,
+    /** Branch */
+    BRANCH = 16
+}
+/** Influence certain aspects of how AppStream metadata is parsed. */
+export declare enum ParseFlags {
+    /** No flags. */
+    NONE = 0,
+    /** Do not process the media_baseurl document property. */
+    IGNORE_MEDIABASEURL = 1
+}
+/** Flags controlling the metadata pool behavior. */
+export declare enum PoolFlags {
+    /** No flags. */
+    NONE = 0,
+    /** Load AppStream catalog metadata from OS locations. */
+    LOAD_OS_CATALOG = 1,
+    /** Load MetaInfo data from OS locations. */
+    LOAD_OS_METAINFO = 2,
+    /** Load components from desktop-entry files in OS locations. */
+    LOAD_OS_DESKTOP_FILES = 4,
+    /** Load AppStream catalog metadata from Flatpak. */
+    LOAD_FLATPAK = 8,
+    /** Load fresh data even if an up-o-date cache is available. */
+    IGNORE_CACHE_AGE = 16,
+    /** Always resolve addons for returned components. */
+    RESOLVE_ADDONS = 32,
+    /**
+     * Prefer local metainfo data over the system-provided catalog data. Useful for previewing local data.
+     */
+    PREFER_OS_METAINFO = 64,
+    /**
+     * Monitor registered directories for changes, and auto-reload metadata if necessary.
+     */
+    MONITOR = 128
+}
+/** The flags for the review. */
+export declare enum ReviewFlags {
+    /** No special flags set */
+    NONE = 0,
+    /** The user wrote the review themselves */
+    SELF = 1,
+    /** The user voted on the review */
+    VOTED = 2
+}
+/**
+ * Set how values assigned to an #AsComponent should be treated when
+ * they are set or retrieved.
+ */
+export declare enum ValueFlags {
+    /** No flags. */
+    NONE = 0,
+    /** Check for duplicates when adding items to list values. */
+    DUPLICATE_CHECK = 1,
+    /** Don't fall back to C when retrieving translated values. */
+    NO_TRANSLATION_FALLBACK = 2
+}
+/** The flags used when matching unique IDs. */
+export declare enum VercmpFlags {
+    /** No flags set */
+    NONE = 0,
+    /** Ignore epoch part of a version string. */
+    IGNORE_EPOCH = 1
+}