@gtkx/ffi 0.5.2 → 0.6.0

package/dist/generated/appstream/validator.js

@@ -0,0 +1,422 @@
+import { call, NativeError, getObject, isInstantiating, setInstantiating, registerType, } from "@gtkx/ffi";
+import * as GObject from "../gobject/index.js";
+export class Validator extends GObject.GObject {
+    static glibTypeName = "AsValidator";
+    /**
+     * Creates a new #AsValidator.
+     */
+    constructor() {
+        if (!isInstantiating) {
+            setInstantiating(true);
+            // @ts-ignore
+            super();
+            setInstantiating(false);
+            this.id = call("libappstream.so.5", "as_validator_new", [], {
+                type: "gobject",
+                borrowed: true,
+            });
+        }
+        else {
+            // @ts-ignore
+            super();
+        }
+    }
+    /**
+     * Override the severity of a selected tag. For most tags, the severity
+     * can not be lowered to a value that makes a validation
+     * that would otherwise fail pass (so e.g. an ERROR can not become an INFO).
+     * Some tags are explicitly allowed to have their severity lowered to enable
+     * validation of e.g. incomplete metadata during development.
+     * Increasing the severity of any tag is always allowed.
+     * @param tag - the issue tag to override, e.g. "release-time-missing"
+     * @param severityOverride - the new severity for the tag.
+     */
+    addOverride(tag, severityOverride) {
+        const error = { value: null };
+        const result = call("libappstream.so.5", "as_validator_add_override", [
+            {
+                type: { type: "gobject" },
+                value: this.id,
+            },
+            {
+                type: { type: "string" },
+                value: tag,
+            },
+            {
+                type: { type: "int", size: 32, unsigned: false },
+                value: severityOverride,
+            },
+            {
+                type: {
+                    type: "ref",
+                    innerType: {
+                        type: "boxed",
+                        innerType: "GError",
+                        lib: "libglib-2.0.so.0",
+                    },
+                },
+                value: error,
+            },
+        ], { type: "boolean" });
+        if (error.value !== null) {
+            throw new NativeError(error.value);
+        }
+        return result;
+    }
+    /**
+     * Add release metadata explicitly from bytes.
+     * @param releaseFname - File basename of the release metadata file to add.
+     * @param releaseMetadata - Data of the release metadata file.
+     */
+    addReleaseBytes(releaseFname, releaseMetadata) {
+        const error = { value: null };
+        const result = call("libappstream.so.5", "as_validator_add_release_bytes", [
+            {
+                type: { type: "gobject" },
+                value: this.id,
+            },
+            {
+                type: { type: "string" },
+                value: releaseFname,
+            },
+            {
+                type: {
+                    type: "boxed",
+                    borrowed: true,
+                    innerType: "GBytes",
+                    lib: "libappstream.so.5",
+                },
+                value: releaseMetadata?.id ?? releaseMetadata,
+            },
+            {
+                type: {
+                    type: "ref",
+                    innerType: {
+                        type: "boxed",
+                        innerType: "GError",
+                        lib: "libglib-2.0.so.0",
+                    },
+                },
+                value: error,
+            },
+        ], { type: "boolean" });
+        if (error.value !== null) {
+            throw new NativeError(error.value);
+        }
+        return result;
+    }
+    /**
+     * Add a release metadata file to the validation process.
+     * @param releaseFile - Release metadata file to add.
+     */
+    addReleaseFile(releaseFile) {
+        const error = { value: null };
+        const result = call("libappstream.so.5", "as_validator_add_release_file", [
+            {
+                type: { type: "gobject" },
+                value: this.id,
+            },
+            {
+                type: { type: "gobject", borrowed: true },
+                value: releaseFile?.id ?? releaseFile,
+            },
+            {
+                type: {
+                    type: "ref",
+                    innerType: {
+                        type: "boxed",
+                        innerType: "GError",
+                        lib: "libglib-2.0.so.0",
+                    },
+                },
+                value: error,
+            },
+        ], { type: "boolean" });
+        if (error.value !== null) {
+            throw new NativeError(error.value);
+        }
+        return result;
+    }
+    /**
+     * Check the current registered values again and return %TRUE
+     * if no issues were found that would make the previously validated
+     * files fail validation.
+     *
+     * Usually you do not need to call this function explicitly, as
+     * the as_validator_validate_* functions will already return whether
+     * data was valid as return value.
+     */
+    checkSuccess() {
+        return call("libappstream.so.5", "as_validator_check_success", [
+            {
+                type: { type: "gobject" },
+                value: this.id,
+            },
+        ], { type: "boolean" });
+    }
+    /**
+     * Clear all release information that was explicitly added to the
+     * validation process.
+     */
+    clearReleaseData() {
+        call("libappstream.so.5", "as_validator_clear_release_data", [
+            {
+                type: { type: "gobject" },
+                value: this.id,
+            },
+        ], { type: "undefined" });
+    }
+    getAllowNet() {
+        return call("libappstream.so.5", "as_validator_get_allow_net", [
+            {
+                type: { type: "gobject" },
+                value: this.id,
+            },
+        ], { type: "boolean" });
+    }
+    /**
+     * Get the number of files for which issues have been found.
+     */
+    getIssueFilesCount() {
+        return call("libappstream.so.5", "as_validator_get_issue_files_count", [
+            {
+                type: { type: "gobject" },
+                value: this.id,
+            },
+        ], { type: "int", size: 32, unsigned: true });
+    }
+    /**
+     * Get a list of found metadata format issues.
+     */
+    getIssues() {
+        const ptrs = call("libappstream.so.5", "as_validator_get_issues", [
+            {
+                type: { type: "gobject" },
+                value: this.id,
+            },
+        ], {
+            type: "array",
+            itemType: { type: "gobject" },
+            listType: "glist",
+            borrowed: true,
+        });
+        return ptrs.map((ptr) => getObject(ptr));
+    }
+    /**
+     * Get a hash table of filenames mapped to lists of issues.
+     * This is useful if validation was requested for multiple files and
+     * a list of issues per-file is desired without prior explicit sorting.
+     */
+    getIssuesPerFile() {
+        const ptr = call("libappstream.so.5", "as_validator_get_issues_per_file", [
+            {
+                type: { type: "gobject" },
+                value: this.id,
+            },
+        ], {
+            type: "boxed",
+            borrowed: true,
+            innerType: "GHashTable",
+            lib: "libappstream.so.5",
+        });
+        return getObject(ptr);
+    }
+    getReportYaml() {
+        const error = { value: null };
+        const result = call("libappstream.so.5", "as_validator_get_report_yaml", [
+            {
+                type: { type: "gobject" },
+                value: this.id,
+            },
+            {
+                type: {
+                    type: "ref",
+                    innerType: {
+                        type: "boxed",
+                        innerType: "GError",
+                        lib: "libglib-2.0.so.0",
+                    },
+                },
+                value: error,
+            },
+        ], { type: "string" });
+        if (error.value !== null) {
+            throw new NativeError(error.value);
+        }
+        return result;
+    }
+    getStrict() {
+        return call("libappstream.so.5", "as_validator_get_strict", [
+            {
+                type: { type: "gobject" },
+                value: this.id,
+            },
+        ], { type: "boolean" });
+    }
+    /**
+     * Get the explanatory text for a given issue tag.
+     */
+    getTagExplanation(tag) {
+        return call("libappstream.so.5", "as_validator_get_tag_explanation", [
+            {
+                type: { type: "gobject" },
+                value: this.id,
+            },
+            {
+                type: { type: "string" },
+                value: tag,
+            },
+        ], { type: "string", borrowed: true });
+    }
+    /**
+     * Get the severity for a given issue tag.
+     */
+    getTagSeverity(tag) {
+        return call("libappstream.so.5", "as_validator_get_tag_severity", [
+            {
+                type: { type: "gobject" },
+                value: this.id,
+            },
+            {
+                type: { type: "string" },
+                value: tag,
+            },
+        ], { type: "int", size: 32, unsigned: false });
+    }
+    /**
+     * Get an array of all tags known to the validator.
+     */
+    getTags() {
+        return call("libappstream.so.5", "as_validator_get_tags", [
+            {
+                type: { type: "gobject" },
+                value: this.id,
+            },
+        ], { type: "array", itemType: { type: "string" } });
+    }
+    /**
+     * If set to %TRUE, the validator will be allowed to connect
+     * to the internet to e.g. check URLs for validity.
+     * @param value - %TRUE if remote URLs should be checked for availability.
+     */
+    setAllowNet(value) {
+        call("libappstream.so.5", "as_validator_set_allow_net", [
+            {
+                type: { type: "gobject" },
+                value: this.id,
+            },
+            {
+                type: { type: "boolean" },
+                value: value,
+            },
+        ], { type: "undefined" });
+    }
+    /**
+     * Enable or disable strict mode. In strict mode, any found issue will result
+     * in a failed validation (except for issues of "pedantic" severity).
+     * Otherwise, only a "warning" or "error" will cause the validation to fail.
+     * @param isStrict - %TRUE to enable strict mode.
+     */
+    setStrict(isStrict) {
+        call("libappstream.so.5", "as_validator_set_strict", [
+            {
+                type: { type: "gobject" },
+                value: this.id,
+            },
+            {
+                type: { type: "boolean" },
+                value: isStrict,
+            },
+        ], { type: "undefined" });
+    }
+    /**
+     * Validate AppStream XML data from a byte array.
+     * Remember to run %as_validator_clear_issues if you do not want previous
+     * validation runs to affect the outcome of this validation.
+     * @param metadata - XML metadata as #GBytes.
+     */
+    validateBytes(metadata) {
+        return call("libappstream.so.5", "as_validator_validate_bytes", [
+            {
+                type: { type: "gobject" },
+                value: this.id,
+            },
+            {
+                type: {
+                    type: "boxed",
+                    borrowed: true,
+                    innerType: "GBytes",
+                    lib: "libappstream.so.5",
+                },
+                value: metadata?.id ?? metadata,
+            },
+        ], { type: "boolean" });
+    }
+    /**
+     * Validate AppStream XML data.
+     * @param metadata - XML metadata.
+     */
+    validateData(metadata) {
+        return call("libappstream.so.5", "as_validator_validate_data", [
+            {
+                type: { type: "gobject" },
+                value: this.id,
+            },
+            {
+                type: { type: "string" },
+                value: metadata,
+            },
+        ], { type: "boolean" });
+    }
+    /**
+     * Validate an AppStream XML file.
+     * @param metadataFile - An AppStream XML file.
+     */
+    validateFile(metadataFile) {
+        return call("libappstream.so.5", "as_validator_validate_file", [
+            {
+                type: { type: "gobject" },
+                value: this.id,
+            },
+            {
+                type: { type: "gobject", borrowed: true },
+                value: metadataFile?.id ?? metadataFile,
+            },
+        ], { type: "boolean" });
+    }
+    /**
+     * Validate a full directory tree for issues in AppStream metadata.
+     * @param rootDir - The root directory of the filesystem tree that should be validated.
+     */
+    validateTree(rootDir) {
+        return call("libappstream.so.5", "as_validator_validate_tree", [
+            {
+                type: { type: "gobject" },
+                value: this.id,
+            },
+            {
+                type: { type: "string" },
+                value: rootDir,
+            },
+        ], { type: "boolean" });
+    }
+    connect(signal, handler, after = false) {
+        const selfType = { type: "gobject", borrowed: true };
+        const argTypes = [selfType];
+        const returnType = undefined;
+        const wrappedHandler = (...args) => {
+            const self = getObject(args[0]);
+            return handler(self, ...args.slice(1));
+        };
+        return call("libappstream.so.5", "g_signal_connect_closure", [
+            { type: { type: "gobject" }, value: this.id },
+            { type: { type: "string" }, value: signal },
+            {
+                type: { type: "callback", argTypes, returnType },
+                value: wrappedHandler,
+            },
+            { type: { type: "boolean" }, value: after },
+        ], { type: "int", size: 64, unsigned: true });
+    }
+}
+registerType(Validator);

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

@@ -0,0 +1,65 @@
+import { VideoCodecKind, VideoContainerKind } from "./enums.js";
+import * as GObject from "../gobject/index.js";
+export declare class Video extends GObject.GObject {
+    static readonly glibTypeName: string;
+    /**
+     * Creates a new #AsVideo.
+     */
+    constructor();
+    /**
+     * Gets the video codec, if known.
+     */
+    getCodecKind(): VideoCodecKind;
+    /**
+     * Gets the video container format, if known.
+     */
+    getContainerKind(): VideoContainerKind;
+    /**
+     * Gets the video height, if known.
+     */
+    getHeight(): number;
+    /**
+     * Get locale for this video.
+     */
+    getLocale(): string;
+    /**
+     * Gets the full qualified URL for the video, usually pointing at a mirror or CDN server.
+     */
+    getUrl(): string;
+    /**
+     * Gets the video width, if known.
+     */
+    getWidth(): number;
+    /**
+     * Sets the video codec.
+     * @param kind - the #AsVideoCodecKind, e.g. %AS_VIDEO_CODEC_KIND_AV1.
+     */
+    setCodecKind(kind: VideoCodecKind): void;
+    /**
+     * Sets the video container.
+     * @param kind - the #AsVideoContainerKind, e.g. %AS_VIDEO_CONTAINER_KIND_MKV.
+     */
+    setContainerKind(kind: VideoContainerKind): void;
+    /**
+     * Sets the video height.
+     * @param height - the height in pixels.
+     */
+    setHeight(height: number): void;
+    /**
+     * Sets the locale for this video.
+     * @param locale - the BCP47 locale string.
+     */
+    setLocale(locale: string): void;
+    /**
+     * Sets the fully-qualified URL to use for the video.
+     * @param url - the URL.
+     */
+    setUrl(url: string): void;
+    /**
+     * Sets the video width.
+     * @param width - the width in pixels.
+     */
+    setWidth(width: number): void;
+    connect(signal: "notify", handler: (self: Video, pspec: GObject.ParamSpec) => void, after?: boolean): number;
+    connect(signal: string, handler: (...args: any[]) => any, after?: boolean): number;
+}

package/dist/generated/appstream/video.js

@@ -0,0 +1,205 @@
+import { call, getObject, isInstantiating, setInstantiating, registerType, } from "@gtkx/ffi";
+import * as GObject from "../gobject/index.js";
+export class Video extends GObject.GObject {
+    static glibTypeName = "AsVideo";
+    /**
+     * Creates a new #AsVideo.
+     */
+    constructor() {
+        if (!isInstantiating) {
+            setInstantiating(true);
+            // @ts-ignore
+            super();
+            setInstantiating(false);
+            this.id = call("libappstream.so.5", "as_video_new", [], {
+                type: "gobject",
+                borrowed: true,
+            });
+        }
+        else {
+            // @ts-ignore
+            super();
+        }
+    }
+    /**
+     * Gets the video codec, if known.
+     */
+    getCodecKind() {
+        return call("libappstream.so.5", "as_video_get_codec_kind", [
+            {
+                type: { type: "gobject" },
+                value: this.id,
+            },
+        ], { type: "int", size: 32, unsigned: false });
+    }
+    /**
+     * Gets the video container format, if known.
+     */
+    getContainerKind() {
+        return call("libappstream.so.5", "as_video_get_container_kind", [
+            {
+                type: { type: "gobject" },
+                value: this.id,
+            },
+        ], { type: "int", size: 32, unsigned: false });
+    }
+    /**
+     * Gets the video height, if known.
+     */
+    getHeight() {
+        return call("libappstream.so.5", "as_video_get_height", [
+            {
+                type: { type: "gobject" },
+                value: this.id,
+            },
+        ], { type: "int", size: 32, unsigned: true });
+    }
+    /**
+     * Get locale for this video.
+     */
+    getLocale() {
+        return call("libappstream.so.5", "as_video_get_locale", [
+            {
+                type: { type: "gobject" },
+                value: this.id,
+            },
+        ], { type: "string", borrowed: true });
+    }
+    /**
+     * Gets the full qualified URL for the video, usually pointing at a mirror or CDN server.
+     */
+    getUrl() {
+        return call("libappstream.so.5", "as_video_get_url", [
+            {
+                type: { type: "gobject" },
+                value: this.id,
+            },
+        ], { type: "string", borrowed: true });
+    }
+    /**
+     * Gets the video width, if known.
+     */
+    getWidth() {
+        return call("libappstream.so.5", "as_video_get_width", [
+            {
+                type: { type: "gobject" },
+                value: this.id,
+            },
+        ], { type: "int", size: 32, unsigned: true });
+    }
+    /**
+     * Sets the video codec.
+     * @param kind - the #AsVideoCodecKind, e.g. %AS_VIDEO_CODEC_KIND_AV1.
+     */
+    setCodecKind(kind) {
+        call("libappstream.so.5", "as_video_set_codec_kind", [
+            {
+                type: { type: "gobject" },
+                value: this.id,
+            },
+            {
+                type: { type: "int", size: 32, unsigned: false },
+                value: kind,
+            },
+        ], { type: "undefined" });
+    }
+    /**
+     * Sets the video container.
+     * @param kind - the #AsVideoContainerKind, e.g. %AS_VIDEO_CONTAINER_KIND_MKV.
+     */
+    setContainerKind(kind) {
+        call("libappstream.so.5", "as_video_set_container_kind", [
+            {
+                type: { type: "gobject" },
+                value: this.id,
+            },
+            {
+                type: { type: "int", size: 32, unsigned: false },
+                value: kind,
+            },
+        ], { type: "undefined" });
+    }
+    /**
+     * Sets the video height.
+     * @param height - the height in pixels.
+     */
+    setHeight(height) {
+        call("libappstream.so.5", "as_video_set_height", [
+            {
+                type: { type: "gobject" },
+                value: this.id,
+            },
+            {
+                type: { type: "int", size: 32, unsigned: true },
+                value: height,
+            },
+        ], { type: "undefined" });
+    }
+    /**
+     * Sets the locale for this video.
+     * @param locale - the BCP47 locale string.
+     */
+    setLocale(locale) {
+        call("libappstream.so.5", "as_video_set_locale", [
+            {
+                type: { type: "gobject" },
+                value: this.id,
+            },
+            {
+                type: { type: "string" },
+                value: locale,
+            },
+        ], { type: "undefined" });
+    }
+    /**
+     * Sets the fully-qualified URL to use for the video.
+     * @param url - the URL.
+     */
+    setUrl(url) {
+        call("libappstream.so.5", "as_video_set_url", [
+            {
+                type: { type: "gobject" },
+                value: this.id,
+            },
+            {
+                type: { type: "string" },
+                value: url,
+            },
+        ], { type: "undefined" });
+    }
+    /**
+     * Sets the video width.
+     * @param width - the width in pixels.
+     */
+    setWidth(width) {
+        call("libappstream.so.5", "as_video_set_width", [
+            {
+                type: { type: "gobject" },
+                value: this.id,
+            },
+            {
+                type: { type: "int", size: 32, unsigned: true },
+                value: width,
+            },
+        ], { type: "undefined" });
+    }
+    connect(signal, handler, after = false) {
+        const selfType = { type: "gobject", borrowed: true };
+        const argTypes = [selfType];
+        const returnType = undefined;
+        const wrappedHandler = (...args) => {
+            const self = getObject(args[0]);
+            return handler(self, ...args.slice(1));
+        };
+        return call("libappstream.so.5", "g_signal_connect_closure", [
+            { type: { type: "gobject" }, value: this.id },
+            { type: { type: "string" }, value: signal },
+            {
+                type: { type: "callback", argTypes, returnType },
+                value: wrappedHandler,
+            },
+            { type: { type: "boolean" }, value: after },
+        ], { type: "int", size: 64, unsigned: true });
+    }
+}
+registerType(Video);