@gtkx/ffi 0.5.2 → 0.6.0

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

@@ -0,0 +1,712 @@
+import { Ref } from "@gtkx/native";
+import { AgreementKind, ArtifactKind, BundleKind, ChassisKind, ChecksumKind, ColorKind, ColorSchemeKind, ComponentKind, ComponentScope, ContentRatingSystem, ContentRatingValue, ControlKind, DataIdMatchFlags, DisplaySideKind, FormatKind, FormatVersion, IconKind, ImageKind, InternetKind, IssueKind, IssueSeverity, LaunchableKind, MarkupKind, MergeKind, MetadataLocation, ProvidedKind, ReferenceKind, RelationCompare, RelationItemKind, RelationKind, ReleaseKind, ReleaseListKind, ReleaseUrlKind, ScreenshotKind, SizeKind, SuggestedKind, TranslationKind, UrgencyKind, UrlKind, VercmpFlags, VideoCodecKind, VideoContainerKind } from "./enums.js";
+import * as GLib from "../glib/index.js";
+/**
+ * Converts the text representation to an enumerated value.
+ * @param value - the string.
+ */
+export declare const agreementKindFromString: (value: string) => AgreementKind;
+/**
+ * Converts the enumerated value to an text representation.
+ * @param value - the #AsAgreementKind.
+ */
+export declare const agreementKindToString: (value: AgreementKind) => string;
+/**
+ * Converts the text representation to an enumerated value.
+ * @param kind - the string.
+ */
+export declare const artifactKindFromString: (kind: string) => ArtifactKind;
+/**
+ * Converts the enumerated value to an text representation.
+ * @param kind - the #AsArtifactKind.
+ */
+export declare const artifactKindToString: (kind: ArtifactKind) => string;
+/**
+ * Converts the text representation to an enumerated value.
+ * @param bundleStr - the string.
+ */
+export declare const bundleKindFromString: (bundleStr: string) => BundleKind;
+/**
+ * Converts the enumerated value to an text representation.
+ * @param kind - the %AsBundleKind.
+ */
+export declare const bundleKindToString: (kind: BundleKind) => string;
+/**
+ * Converts the text representation to an enumerated value.
+ * @param kindStr - the string.
+ */
+export declare const chassisKindFromString: (kindStr: string) => ChassisKind;
+/**
+ * Converts the enumerated value to a text representation.
+ * @param kind - the #AsChassisKind.
+ */
+export declare const chassisKindToString: (kind: ChassisKind) => string;
+/**
+ * Converts the text representation to an enumerated value.
+ * @param kindStr - the string.
+ */
+export declare const checksumKindFromString: (kindStr: string) => ChecksumKind;
+/**
+ * Converts the enumerated value to an text representation.
+ * @param kind - the %AsChecksumKind.
+ */
+export declare const checksumKindToString: (kind: ChecksumKind) => string;
+/**
+ * Converts the text representation to an enumerated value.
+ * @param str - the string.
+ */
+export declare const colorKindFromString: (str: string) => ColorKind;
+/**
+ * Converts the enumerated value to an text representation.
+ * @param kind - the %AsColorKind.
+ */
+export declare const colorKindToString: (kind: ColorKind) => string;
+/**
+ * Converts the text representation to an enumerated value.
+ * @param str - the string.
+ */
+export declare const colorSchemeKindFromString: (str: string) => ColorSchemeKind;
+/**
+ * Converts the enumerated value to an text representation.
+ * @param kind - the %AsColorSchemeKind.
+ */
+export declare const colorSchemeKindToString: (kind: ColorSchemeKind) => string;
+/**
+ * Converts the text representation to an enumerated value.
+ * @param kindStr - the string.
+ */
+export declare const componentKindFromString: (kindStr: string) => ComponentKind;
+/**
+ * Converts the enumerated value to an text representation.
+ * @param kind - the #AsComponentKind.
+ */
+export declare const componentKindToString: (kind: ComponentKind) => string;
+/**
+ * Converts the text representation to an enumerated value.
+ * @param scopeStr - the string.
+ */
+export declare const componentScopeFromString: (scopeStr: string) => ComponentScope;
+/**
+ * Converts the enumerated value to an text representation.
+ * @param scope - the #AsComponentScope.
+ */
+export declare const componentScopeToString: (scope: ComponentScope) => string;
+/**
+ * Format `age` as a human-readable string in the given rating @system. This is
+ * the way to present system-specific strings in a UI.
+ * @param system - an #AsContentRatingSystem
+ * @param age - a CSM age to format
+ */
+export declare const contentRatingSystemFormatAge: (system: ContentRatingSystem, age: number) => string | null;
+/**
+ * Determine the most appropriate #AsContentRatingSystem for the given @locale.
+ * Content rating systems are selected by territory. If no content rating system
+ * seems suitable, %AS_CONTENT_RATING_SYSTEM_IARC is returned.
+ * @param locale - a locale, in the format described in `man 3 setlocale`
+ */
+export declare const contentRatingSystemFromLocale: (locale: string) => ContentRatingSystem;
+/**
+ * Get the CSM ages corresponding to the entries returned by
+ * as_content_rating_system_get_formatted_ages() for this @system.
+ * @param system - an #AsContentRatingSystem
+ * @param lengthOut - return location for the length of the
+ */
+export declare const contentRatingSystemGetCsmAges: (system: ContentRatingSystem, lengthOut: Ref<number>) => number[];
+/**
+ * Get an array of all the possible return values of
+ * as_content_rating_system_format_age() for the given @system. The array is
+ * sorted with youngest CSM age first.
+ * @param system - an #AsContentRatingSystem
+ */
+export declare const contentRatingSystemGetFormattedAges: (system: ContentRatingSystem) => string[];
+/**
+ * Get a human-readable string to identify @system. %NULL will be returned for
+ * %AS_CONTENT_RATING_SYSTEM_UNKNOWN.
+ * @param system - an #AsContentRatingSystem
+ */
+export declare const contentRatingSystemToString: (system: ContentRatingSystem) => string | null;
+/**
+ * Converts the text representation to an enumerated value.
+ * @param value - the string.
+ */
+export declare const contentRatingValueFromString: (value: string) => ContentRatingValue;
+/**
+ * Converts the enumerated value to an text representation.
+ * @param value - the #AsContentRatingValue.
+ */
+export declare const contentRatingValueToString: (value: ContentRatingValue) => string;
+/**
+ * Converts the text representation to an enumerated value.
+ * @param kindStr - the string.
+ */
+export declare const controlKindFromString: (kindStr: string) => ControlKind;
+/**
+ * Converts the enumerated value to a text representation.
+ * @param kind - the #AsControlKind.
+ */
+export declare const controlKindToString: (kind: ControlKind) => string;
+/**
+ * Converts the text representation to an enumerated value.
+ * @param kindStr - the string.
+ */
+export declare const displaySideKindFromString: (kindStr: string) => DisplaySideKind;
+/**
+ * Converts the enumerated value to a text representation.
+ * @param kind - the #AsDisplaySideKind.
+ */
+export declare const displaySideKindToString: (kind: DisplaySideKind) => string;
+/**
+ * Converts the text representation to an enumerated value.
+ * @param kindStr - the string.
+ */
+export declare const formatKindFromString: (kindStr: string) => FormatKind;
+/**
+ * Converts the enumerated value to an text representation.
+ * @param kind - the #AsFormatKind.
+ */
+export declare const formatKindToString: (kind: FormatKind) => string;
+/**
+ * Converts the text representation to an enumerated value.
+ * @param versionStr - the string.
+ */
+export declare const formatVersionFromString: (versionStr: string) => FormatVersion;
+/**
+ * Converts the enumerated value to an text representation.
+ * @param version - the #AsFormatKind.
+ */
+export declare const formatVersionToString: (version: FormatVersion) => string;
+/**
+ * Returns the component-ID of the current distribution based on contents
+ * of the `/etc/os-release` file.
+ * This function is a shorthand for %as_distro_details_get_cid
+ */
+export declare const getCurrentDistroComponentId: () => string;
+/**
+ * Get a list of the default Freedesktop and AppStream categories
+ * that software components (especially GUI applications) can be sorted
+ * into in software centers.
+ *
+ * This function fully transfers ownership of the returned container,
+ * to be used in GIR bindings.
+ * @param withSpecial - Include special categories (e.g. "addons", and "all"/"featured" in submenus)
+ */
+export declare const getDefaultCategoriesGi: (withSpecial: boolean) => GLib.PtrArray;
+/**
+ * Get a translated license name for the given SPDX ID.
+ * @param license - The SPDX license ID.
+ */
+export declare const getLicenseName: (license: string) => string | null;
+/**
+ * Get a web URL to the license text and more license information for an SPDX
+ * license identifier.
+ * @param license - The SPDX license ID.
+ */
+export declare const getLicenseUrl: (license: string) => string | null;
+/**
+ * Replaces the string `find` with the string `replace` in a #GString up to
+ * `limit` times. If the number of instances of `find` in the #GString is
+ * less than @limit, all instances are replaced. If `limit` is `0`,
+ * all instances of `find` are replaced.
+ * @param string - a #GString
+ * @param find - the string to find in @string
+ * @param replace - the string to insert in place of @find
+ * @param limit - the maximum instances of `find` to replace with @replace, or `0` for no limit
+ */
+export declare const gstringReplace: (string: GLib.String, find: string, replace: string, limit: number) => number;
+/**
+ * Converts the text representation to an enumerated value.
+ * @param kindStr - the string.
+ */
+export declare const iconKindFromString: (kindStr: string) => IconKind;
+/**
+ * Converts the enumerated value to an text representation.
+ * @param kind - the %AsIconKind.
+ */
+export declare const iconKindToString: (kind: IconKind) => string;
+/**
+ * Converts the text representation to an enumerated value.
+ * @param kind - the string.
+ */
+export declare const imageKindFromString: (kind: string) => ImageKind;
+/**
+ * Converts the enumerated value to an text representation.
+ * @param kind - the #AsImageKind.
+ */
+export declare const imageKindToString: (kind: ImageKind) => string;
+/**
+ * Converts the text representation to an enumerated value.
+ * @param kindStr - the string.
+ */
+export declare const internetKindFromString: (kindStr: string) => InternetKind;
+/**
+ * Converts the enumerated value to a text representation.
+ * @param kind - the #AsInternetKind.
+ */
+export declare const internetKindToString: (kind: InternetKind) => string;
+/**
+ * Searches the known list of SPDX license exception IDs.
+ * @param exceptionId - a single SPDX license exception ID, e.g. "GCC-exception-3.1"
+ */
+export declare const isSpdxLicenseExceptionId: (exceptionId: string) => boolean;
+/**
+ * Checks the licence string to check it being a valid licence.
+ * NOTE: SPDX licenses can't typically contain brackets.
+ * @param license - a SPDX license string, e.g. "CC-BY-3.0 and GFDL-1.3"
+ */
+export declare const isSpdxLicenseExpression: (license: string) => boolean;
+/**
+ * Searches the known list of SPDX license IDs.
+ * @param licenseId - a single SPDX license ID, e.g. "GPL-3.0"
+ */
+export declare const isSpdxLicenseId: (licenseId: string) => boolean;
+/**
+ * Converts the text representation to an enumerated value.
+ * @param kindStr - the string.
+ */
+export declare const issueKindFromString: (kindStr: string) => IssueKind;
+/**
+ * Converts the enumerated value to an text representation.
+ * @param kind - the %AsIssueKind.
+ */
+export declare const issueKindToString: (kind: IssueKind) => string;
+/**
+ * Converts the text representation to an enumerated value.
+ * @param str - the string.
+ */
+export declare const issueSeverityFromString: (str: string) => IssueSeverity;
+/**
+ * Converts the enumerated value to an text representation.
+ * @param severity - the #AsIssueSeverity.
+ */
+export declare const issueSeverityToString: (severity: IssueSeverity) => string;
+/**
+ * Converts the text representation to an enumerated value.
+ * @param kindStr - the string.
+ */
+export declare const launchableKindFromString: (kindStr: string) => LaunchableKind;
+/**
+ * Converts the enumerated value to a text representation.
+ * @param kind - the #AsLaunchableKind.
+ */
+export declare const launchableKindToString: (kind: LaunchableKind) => string;
+/**
+ * Check if the given license is for free-as-in-freedom software.
+ * A free software license is either approved by the Free Software Foundation
+ * or the Open Source Initiative.
+ *
+ * This function does *not* yet handle complex license expressions with AND and OR.
+ * If the expression contains any of these, it will still simply check if all mentioned
+ * licenses are Free licenses.
+ * Currently, any license exception recognized by SPDX is assumed to not impact the free-ness
+ * status of a software component.
+ *
+ * Please note that this function does not give any legal advice. Please read the license texts
+ * to learn more about the individual licenses and their conditions.
+ * @param license - The SPDX license string to test.
+ */
+export declare const licenseIsFreeLicense: (license: string) => boolean;
+/**
+ * Check if the metadata license is suitable for mixing with other
+ * metadata and redistributing the bundled result (this means we
+ * prefer permissive licenses here, to not require people shipping
+ * catalog metadata to perform a full license review).
+ *
+ * This method checks against a hardcoded list of permissive licenses
+ * commonly used to license metadata under.
+ * @param license - The SPDX license string to test.
+ */
+export declare const licenseIsMetadataLicense: (license: string) => boolean;
+/**
+ * Tests license ID against the vetted list of licenses that
+ * can be used for metainfo metadata.
+ * This function will not work for license expressions, if you need
+ * to test an SPDX license expression for compliance, please
+ * use %as_license_is_metadata_license insread.
+ * @param licenseId - a single SPDX license ID, e.g. "FSFAP"
+ */
+export declare const licenseIsMetadataLicenseId: (licenseId: string) => boolean;
+/**
+ * Converts a non-SPDX license into an SPDX format string where possible.
+ * @param license - a not-quite SPDX license string, e.g. "GPLv3+"
+ */
+export declare const licenseToSpdxId: (license: string) => string;
+/**
+ * Converts XML description markup into other forms of text.
+ * @param markup - the XML markup to transform.
+ * @param toKind - The markup style to convert into.
+ */
+export declare const markupConvert: (markup: string, toKind: MarkupKind) => string;
+/**
+ * Splits up a long line into an array of smaller strings, each being no longer
+ * than @line_len. Words are not split.
+ * @param text - the text to split.
+ * @param lineLen - the maximum length of the output line
+ */
+export declare const markupStrsplitWords: (text: string, lineLen: number) => string[];
+/**
+ * Converts the text representation to an enumerated value.
+ * @param kindStr - the string.
+ */
+export declare const mergeKindFromString: (kindStr: string) => MergeKind;
+/**
+ * Converts the enumerated value to an text representation.
+ * @param kind - the #AsMergeKind.
+ */
+export declare const mergeKindToString: (kind: MergeKind) => string;
+export declare const metadataErrorQuark: () => number;
+export declare const poolErrorQuark: () => number;
+/**
+ * Converts the text representation to an enumerated value.
+ * @param kindStr - the string.
+ */
+export declare const providedKindFromString: (kindStr: string) => ProvidedKind;
+/**
+ * Converts the enumerated value to a localized text representation,
+ * using the plural forms (e.g. "Libraries" instead of "Library").
+ *
+ * This can be useful when displaying provided items in GUI dialogs.
+ * @param kind - the #AsProvidedKind.
+ */
+export declare const providedKindToL10nString: (kind: ProvidedKind) => string;
+/**
+ * Converts the enumerated value to a text representation.
+ * @param kind - the #AsProvidedKind.
+ */
+export declare const providedKindToString: (kind: ProvidedKind) => string;
+/**
+ * Converts the text representation to an enumerated value.
+ * @param str - the string.
+ */
+export declare const referenceKindFromString: (str: string) => ReferenceKind;
+/**
+ * Converts the enumerated value to an text representation.
+ * @param kind - the %AsReferenceKind.
+ */
+export declare const referenceKindToString: (kind: ReferenceKind) => string;
+/**
+ * Converts the text representation to an enumerated value.
+ * @param compareStr - the string.
+ */
+export declare const relationCompareFromString: (compareStr: string) => RelationCompare;
+/**
+ * Converts the enumerated value to an text representation.
+ * The enum is converted into a two-letter identifier ("eq", "ge", etc.)
+ * for use in the XML representation.
+ * @param compare - the #AsRelationCompare.
+ */
+export declare const relationCompareToString: (compare: RelationCompare) => string;
+/**
+ * Converts the enumerated value to an text representation.
+ * The enum is converted into an identifier consisting of two
+ * mathematical comparison operators ("==", ">=", etc.)
+ * for use in the YAML representation and user interfaces.
+ * @param compare - the #AsRelationCompare.
+ */
+export declare const relationCompareToSymbolsString: (compare: RelationCompare) => string;
+export declare const relationErrorQuark: () => number;
+/**
+ * Converts the text representation to an enumerated value.
+ * @param kindStr - the string.
+ */
+export declare const relationItemKindFromString: (kindStr: string) => RelationItemKind;
+/**
+ * Converts the enumerated value to a text representation.
+ * @param kind - the #AsRelationKind.
+ */
+export declare const relationItemKindToString: (kind: RelationItemKind) => string;
+/**
+ * Converts the text representation to an enumerated value.
+ * @param kindStr - the string.
+ */
+export declare const relationKindFromString: (kindStr: string) => RelationKind;
+/**
+ * Converts the enumerated value to a text representation.
+ * @param kind - the #AsRelationKind.
+ */
+export declare const relationKindToString: (kind: RelationKind) => string;
+/**
+ * Converts the text representation to an enumerated value.
+ * @param kindStr - the string.
+ */
+export declare const releaseKindFromString: (kindStr: string) => ReleaseKind;
+/**
+ * Converts the enumerated value to an text representation.
+ * @param kind - the #AsReleaseKind.
+ */
+export declare const releaseKindToString: (kind: ReleaseKind) => string;
+/**
+ * Converts the text representation to an enumerated value.
+ * @param kindStr - the string.
+ */
+export declare const releaseListKindFromString: (kindStr: string) => ReleaseListKind;
+/**
+ * Converts the enumerated value to an text representation.
+ * @param kind - the #AsReleaseKind.
+ */
+export declare const releaseListKindToString: (kind: ReleaseListKind) => string;
+/**
+ * Converts the text representation to an enumerated value.
+ * @param kindStr - the string.
+ */
+export declare const releaseUrlKindFromString: (kindStr: string) => ReleaseUrlKind;
+/**
+ * Converts the enumerated value to an text representation.
+ * @param kind - the #AsReleaseUrlKind.
+ */
+export declare const releaseUrlKindToString: (kind: ReleaseUrlKind) => string;
+/**
+ * Converts the text representation to an enumerated value.
+ * @param kind - the string.
+ */
+export declare const screenshotKindFromString: (kind: string) => ScreenshotKind;
+/**
+ * Converts the enumerated value to an text representation.
+ * @param kind - the #AsScreenshotKind.
+ */
+export declare const screenshotKindToString: (kind: ScreenshotKind) => string;
+/**
+ * Converts the text representation to an enumerated value.
+ * @param sizeKind - the string.
+ */
+export declare const sizeKindFromString: (sizeKind: string) => SizeKind;
+/**
+ * Converts the enumerated value to an text representation.
+ * @param sizeKind - the #AsSizeKind.
+ */
+export declare const sizeKindToString: (sizeKind: SizeKind) => string;
+/**
+ * De-tokenizes the SPDX licenses into a string.
+ * @param licenseTokens - license tokens, typically from as_spdx_license_tokenize()
+ */
+export declare const spdxLicenseDetokenize: (licenseTokens: string) => string | null;
+/**
+ * Tokenizes the SPDX license string (or any simarly formatted string)
+ * into parts. Any license parts of the string e.g. "LGPL-2.0+" are prefexed
+ * with "@", the conjunctive replaced with "&", the disjunctive replaced
+ * with "|" and the WITH operator for license exceptions replaced with "^".
+ * Brackets are added as indervidual tokens and other strings are
+ * appended into single tokens where possible.
+ * @param license - a license string, e.g. "LGPLv2+ and (QPL or GPLv2) and MIT"
+ */
+export declare const spdxLicenseTokenize: (license: string) => string[] | null;
+/**
+ * Converts the text representation to an enumerated value.
+ * @param kindStr - the string.
+ */
+export declare const suggestedKindFromString: (kindStr: string) => SuggestedKind;
+/**
+ * Converts the enumerated value to an text representation.
+ * @param kind - the %AsSuggestedKind.
+ */
+export declare const suggestedKindToString: (kind: SuggestedKind) => string;
+export declare const systemInfoErrorQuark: () => number;
+/**
+ * Converts the text representation to an enumerated value.
+ * @param kindStr - the string.
+ */
+export declare const translationKindFromString: (kindStr: string) => TranslationKind;
+/**
+ * Converts the enumerated value to a text representation.
+ * @param kind - the #AsTranslationKind.
+ */
+export declare const translationKindToString: (kind: TranslationKind) => string;
+/**
+ * Converts the text representation to an enumerated value.
+ * @param urgencyKind - the string.
+ */
+export declare const urgencyKindFromString: (urgencyKind: string) => UrgencyKind;
+/**
+ * Converts the enumerated value to an text representation.
+ * @param urgencyKind - the %AsUrgencyKind.
+ */
+export declare const urgencyKindToString: (urgencyKind: UrgencyKind) => string;
+/**
+ * Converts the text representation to an enumerated value.
+ * @param urlKind - the string.
+ */
+export declare const urlKindFromString: (urlKind: string) => UrlKind;
+/**
+ * Converts the enumerated value to an text representation.
+ * @param urlKind - the %AsUrlKind.
+ */
+export declare const urlKindToString: (urlKind: UrlKind) => string;
+/**
+ * Builds an identifier string unique to the individual dataset using the supplied information.
+ * @param scope - Scope of the metadata as #AsComponentScope e.g. %AS_COMPONENT_SCOPE_SYSTEM
+ * @param bundleKind - Bundling system providing this data, e.g. 'package' or 'flatpak'
+ * @param origin - Origin string, e.g. 'os' or 'gnome-apps-nightly'
+ * @param cid - AppStream component ID, e.g. 'org.freedesktop.appstream.cli'
+ * @param branch - Branch, e.g. '3-20' or 'master'
+ */
+export declare const utilsBuildDataId: (scope: ComponentScope, bundleKind: BundleKind, origin: string, cid: string, branch: string) => string;
+/**
+ * Checks two component data IDs for equality allowing globs to match.
+ * @param dataId1 - a data ID
+ * @param dataId2 - another data ID
+ */
+export declare const utilsDataIdEqual: (dataId1: string, dataId2: string) => boolean;
+/**
+ * Get the component-id part of the data-id.
+ * @param dataId - The data-id.
+ */
+export declare const utilsDataIdGetCid: (dataId: string) => string;
+/**
+ * Converts a data-id to a hash value.
+ *
+ * This function implements the widely used DJB hash on the ID subset of the
+ * data-id string.
+ *
+ * It can be passed to g_hash_table_new() as the hash_func parameter,
+ * when using non-NULL strings or unique_ids as keys in a GHashTable.
+ * @param dataId - a data ID
+ */
+export declare const utilsDataIdHash: (dataId: string) => number;
+/**
+ * Checks two data IDs for equality allowing globs to match, whilst also
+ * allowing clients to whitelist sections that have to match.
+ * @param dataId1 - a data ID
+ * @param dataId2 - another data ID
+ * @param matchFlags - a #AsDataIdMatchFlags bitfield, e.g. %AS_DATA_ID_MATCH_FLAG_ID
+ */
+export declare const utilsDataIdMatch: (dataId1: string, dataId2: string, matchFlags: DataIdMatchFlags) => boolean;
+/**
+ * Checks if a data ID is valid i.e. has the correct number of
+ * sections.
+ * @param dataId - a component data ID
+ */
+export declare const utilsDataIdValid: (dataId: string) => boolean;
+export declare const utilsErrorQuark: () => number;
+/**
+ * Get a human-readable, translated name of the desktop environment
+ * represented by the given ID.
+ * @param deId - a desktop environment id.
+ */
+export declare const utilsGetDesktopEnvironmentName: (deId: string) => string;
+/**
+ * Get a human-readable, translated name of the combination
+ * of GUI environment and style. E.g. "plasma:dark" becomes "Plasma (Dark)".
+ * @param envStyle - a GUI environment style ID, e.g. "pantheon:dark"
+ */
+export declare const utilsGetGuiEnvironmentStyleName: (envStyle: string) => string;
+/**
+ * Retrieve the raw search token weight for the given tag name that AppStream uses
+ * internally for searching.
+ * This can be used to implement separate, but compatible search logic.
+ * @param tagName - A tag name in a component element, e.g. "name" or "summary" or "keyword"
+ */
+export declare const utilsGetTagSearchWeight: (tagName: string) => number;
+/**
+ * Guess the #AsComponentScope that applies to a given path.
+ * @param path - The filename to test.
+ */
+export declare const utilsGuessScopeFromPath: (path: string) => ComponentScope;
+/**
+ * Installs an AppStream MetaInfo, AppStream Metadata Catalog or AppStream Icon tarball file
+ * to the right place on the filesystem.
+ * Please note that this function does almost no validation and may guess missing values such
+ * as icon sizes and origin names.
+ * Ensure your metadata is good before installing it.
+ * @param location - the #AsMetadataLocation, e.g. %AS_METADATA_LOCATION_CACHE
+ * @param filename - the full path of the file to install
+ * @param origin - the origin to use for the installation, or %NULL
+ * @param destdir - the destdir to use, or %NULL
+ */
+export declare const utilsInstallMetadataFile: (location: MetadataLocation, filename: string, origin: string, destdir: string) => boolean;
+/**
+ * Searches the known list of registered XDG category names.
+ * See https://specifications.freedesktop.org/menu-spec/latest/category-registry.html
+ * for a reference.
+ * @param categoryName - a XDG category name, e.g. "ProjectManagement"
+ */
+export declare const utilsIsCategoryName: (categoryName: string) => boolean;
+/**
+ * Checks if the submitted desktop environment ID is
+ * known and valid.
+ * @param deId - a desktop environment id.
+ */
+export declare const utilsIsDesktopEnvironment: (deId: string) => boolean;
+/**
+ * Checks if the given identifier is a valid, known GUI environment style.
+ * @param envStyle - a GUI environment style ID, e.g. "pantheon:dark"
+ */
+export declare const utilsIsGuiEnvironmentStyle: (envStyle: string) => boolean;
+/**
+ * Test if the given string is a valid platform triplet recognized by
+ * AppStream.
+ * @param triplet - a platform triplet.
+ */
+export declare const utilsIsPlatformTriplet: (triplet: string) => boolean;
+/**
+ * Searches the known list of TLDs we allow for AppStream IDs.
+ * This excludes internationalized names.
+ * @param tld - a top-level domain without dot, e.g. "de", "org", "name"
+ */
+export declare const utilsIsTld: (tld: string) => boolean;
+/**
+ * Calculates if one locale is compatible with another.
+ * When doing the calculation the locale and language code is taken into
+ * account if possible.
+ * @param locale1 - a BCP47 or POSIX locale string, or %NULL
+ * @param locale2 - a BCP47 or POSIX locale string, or %NULL
+ */
+export declare const utilsLocaleIsCompatible: (locale1?: string | null, locale2?: string | null) => boolean;
+/**
+ * Converts a POSIX locale string to the corresponding IETF BCP47 format.
+ * If the given locale is already in BCP47 format, no change will be done.
+ */
+export declare const utilsPosixLocaleToBcp47: (locale: string) => string;
+/**
+ * Sorts all components in `cpts` into the #AsCategory categories listed in @categories.
+ * @param cpts - List of components.
+ * @param categories - List of categories to sort components into.
+ * @param checkDuplicates - Whether to check for duplicates.
+ */
+export declare const utilsSortComponentsIntoCategories: (cpts: GLib.PtrArray, categories: GLib.PtrArray, checkDuplicates: boolean) => void;
+export declare const validatorErrorQuark: () => number;
+/**
+ * Compare alpha and numeric segments of two software versions,
+ * considering @flags.
+ * @param a - First version number
+ * @param b - Second version number
+ * @param flags - Flags, e.g. %AS_VERCMP_FLAG_NONE
+ */
+export declare const vercmp: (a: string, b: string, flags: VercmpFlags) => number;
+/**
+ * Compare alpha and numeric segments of two software versions.
+ * @param a - First version number
+ * @param b - Second version number
+ */
+export declare const vercmpSimple: (a: string, b: string) => number;
+/**
+ * Compare two version numbers and check if the given version comparator matches.
+ * @param ver1 - first version number
+ * @param compare - the comparison operator
+ * @param ver2 - second version number
+ * @param flags - the #AsVercmpFlags to use
+ */
+export declare const vercmpTestMatch: (ver1: string, compare: RelationCompare, ver2: string, flags: VercmpFlags) => boolean;
+/**
+ * Get the version of the AppStream library that is currently used
+ * at runtime as a string.
+ */
+export declare const versionString: () => string;
+/**
+ * Converts the text representation to an enumerated value.
+ * @param str - the string.
+ */
+export declare const videoCodecKindFromString: (str: string) => VideoCodecKind;
+/**
+ * Converts the enumerated value to an text representation.
+ * @param kind - the #AsVideoCodecKind.
+ */
+export declare const videoCodecKindToString: (kind: VideoCodecKind) => string;
+/**
+ * Converts the text representation to an enumerated value.
+ * @param str - the string.
+ */
+export declare const videoContainerKindFromString: (str: string) => VideoContainerKind;
+/**
+ * Converts the enumerated value to an text representation.
+ * @param kind - the #AsVideoContainerKind.
+ */
+export declare const videoContainerKindToString: (kind: VideoContainerKind) => string;