@girs/gm-0 0.0.0-4.0.0-beta.16

package/README.md

@@ -0,0 +1,86 @@
+
+# Gm-0
+
+![version](https://img.shields.io/npm/v/@girs/gm-0)
+![downloads/week](https://img.shields.io/npm/dw/@girs/gm-0)
+
+
+GJS TypeScript type definitions for Gm-0, generated from library version 0.0.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.0.0-beta.16.
+
+
+## Install
+
+To use this type definitions, install them with NPM:
+```bash
+npm install @girs/gm-0
+```
+
+## Usage
+
+You can import this package into your project like this:
+```ts
+import Gm from '@girs/gm-0';
+```
+
+### Ambient Modules
+
+You can also use [ambient modules](https://github.com/gjsify/ts-for-gir/tree/main/packages/cli#ambient-modules) to import this module like you would do this in JavaScript.
+For this you need to include `@girs/gm-0` or `@girs/gm-0/ambient` in your `tsconfig` or entry point Typescript file:
+
+`index.ts`:
+```ts
+import '@girs/gm-0'
+```
+
+`tsconfig.json`:
+```json
+{
+  "compilerOptions": {
+    ...
+  },
+  "include": ["@girs/gm-0"],
+  ...
+}
+```
+
+Now you can import the ambient module with TypeScript support: 
+
+```ts
+import Gm from 'gi://Gm?version=0';
+```
+
+### Global import
+
+You can also import the module with Typescript support using the global `imports.gi` object of GJS.
+For this you need to include `@girs/gm-0` or `@girs/gm-0/import` in your `tsconfig` or entry point Typescript file:
+
+`index.ts`:
+```ts
+import '@girs/gm-0'
+```
+
+`tsconfig.json`:
+```json
+{
+  "compilerOptions": {
+    ...
+  },
+  "include": ["@girs/gm-0"],
+  ...
+}
+```
+
+Now you have also type support for this, too:
+
+```ts
+const Gm = imports.gi.Gm;
+```
+
+### Bundle
+
+Depending on your project configuration, it is recommended to use a bundler like [esbuild](https://esbuild.github.io/). You can find examples using different bundlers [here](https://github.com/gjsify/ts-for-gir/tree/main/examples).
+
+## Other packages
+
+All existing pre-generated packages can be found on [gjsify/types](https://github.com/gjsify/types).
+

package/gm-0-ambient.d.ts

@@ -0,0 +1,9 @@
+declare module 'gi://Gm?version=0' {
+    import Gm0 from '@girs/gm-0';
+    export default Gm0;
+}
+
+declare module 'gi://Gm' {
+    import Gm0 from 'gi://Gm?version=0';
+    export default Gm0;
+}

package/gm-0-ambient.js

@@ -0,0 +1,2 @@
+export {}
+

package/gm-0-import.d.ts

@@ -0,0 +1,9 @@
+import Gm0 from '@girs/gm-0';
+
+declare global {
+    export interface GjsGiImports {
+        Gm: typeof Gm0;
+    }
+}
+
+export default GjsGiImports;

package/gm-0-import.js

@@ -0,0 +1,3 @@
+const gi = globalThis.imports?.gi || {};
+export default gi;
+

package/gm-0.d.ts

@@ -0,0 +1,388 @@
+/**
+ * Type Definitions for Gjs (https://gjs.guide/)
+ *
+ * These type definitions are automatically generated, do not edit them by hand.
+ * If you found a bug fix it in `ts-for-gir` or create a bug report on https://github.com/gjsify/ts-for-gir
+ *
+ * The based EJS template file is used for the generated .d.ts file of each GIR module like Gtk-4.0, GObject-2.0, ...
+ */
+
+// Module dependencies
+import type Gio from '@girs/gio-2.0';
+import type GObject from '@girs/gobject-2.0';
+import type GLib from '@girs/glib-2.0';
+import type GModule from '@girs/gmodule-2.0';
+
+export namespace Gm {
+    /**
+     * Gm-0
+     */
+
+    /**
+     * Error codes returned by gmobile functions.
+     */
+    class Error extends GLib.Error {
+        static $gtype: GObject.GType<Error>;
+
+        // Static fields
+
+        /**
+         * Parsing of the given data failed.
+         */
+        static ERROR_PARSING_FAILED: number;
+
+        // Constructors
+
+        constructor(options: { message: string; code: number });
+        _init(...args: any[]): void;
+    }
+
+    /**
+     * Read compatible machine types from
+     * `sysfs_root/firmware/devicetree/base/compatible` on Linux.
+     * If the path doesn't exist or host is not Linux return %NULL.
+     *
+     * For debugging purposes `GMOBILE_DT_COMPATIBLES` can be set to a `:`
+     * separated list of compatibles which will be returned instead.
+     * @param sysfs_root Path where /sys is mounted. Defaults to `/sys` if %NULL is passed.
+     * @returns compatible machine types or %NULL
+     */
+    function device_tree_get_compatibles(sysfs_root: string): string[];
+    /**
+     * Gets the GM Error Quark.
+     * @returns a #GQuark.
+     */
+    function error_quark(): GLib.Quark;
+    /**
+     * Call this function to initialize the library explicitly. This makes
+     * the embedded device information available.
+     */
+    function init(): void;
+    /**
+     * Returns the bounding box of an SVG path. As this is meant for
+     * display cutouts we operate on integer (whole pixel) values.  When
+     * parsing fails, `FALSE` is returned and `error` contains the error
+     * information.
+     * @param path An SVG path
+     * @param x1 The lower x coordinate
+     * @param x2 The upper x coordinate
+     * @param y1 The lower y coordinate
+     * @param y2 The upper x coordinate
+     * @returns `TRUE` when parsing was successful, `FALSE` otherwise. See https://developer.mozilla.org/en-US/docs/Web/SVG/Tutorial/Paths for path syntax introduction.
+     */
+    function svg_path_get_bounding_box(path: string, x1: number, x2: number, y1: number, y2: number): boolean;
+    /**
+     * Sets a function to be called after a timeout with priority `priority`.
+     * Correctly calculates the timeout even when the system is suspended in between.
+     *
+     * This internally creates a main loop source using
+     * g_timeout_source_new_seconds() and attaches it to the main loop context
+     * using g_source_attach().
+     *
+     * The timeout given is in terms of `CLOCK_BOOTTIME` time, it hence is also
+     * correct across suspend and resume. If that doesn't matter use
+     * `g_timeout_add_seconds_full` instead.
+     *
+     * Note that glib's `g_timeout_add_seconds()` doesn't take system
+     * suspend/resume into account: https://gitlab.gnome.org/GNOME/glib/-/issues/2739
+     * @param priority the priority of the timeout source. Typically this will be in   the range between %G_PRIORITY_DEFAULT and %G_PRIORITY_HIGH.
+     * @param seconds the timeout in seconds
+     * @param _function function to call
+     * @param notify function to call when the timeout is removed, or %NULL
+     * @returns the ID (greater than 0) of the event source.
+     */
+    function timeout_add_seconds_once(
+        priority: number,
+        seconds: number,
+        _function: GLib.SourceOnceFunc,
+        notify?: GLib.DestroyNotify | null,
+    ): number;
+    module Cutout {
+        // Constructor properties interface
+
+        interface ConstructorProps extends GObject.Object.ConstructorProps {
+            bounds: Rect;
+            name: string;
+            path: string;
+        }
+    }
+
+    /**
+     * A display cutout or notch.
+     *
+     * A display cutout is an area of a display that is not usable for
+     * rendering e.g.  because a camera or speaker is placed there. This
+     * includes so called "notches".  The are needs to be avoided when
+     * rendering. It is described by a SVG path. Each cutouts coordinate
+     * systems is located at the top left display corner in the displays
+     * natural orientation. Applications can query the area to avoid
+     * for rendering via the `bounds` property so they don't need to
+     * deal with the SVG path themselves.
+     */
+    class Cutout extends GObject.Object {
+        static $gtype: GObject.GType<Cutout>;
+
+        // Properties
+
+        /**
+         * Rectangular bounds of the cutout
+         */
+        get bounds(): Rect;
+        /**
+         * A name identifying the cutout.
+         */
+        get name(): string;
+        /**
+         * The SVG path that describes the display cutout or notch.
+         */
+        get path(): string;
+
+        // Constructors
+
+        constructor(properties?: Partial<Cutout.ConstructorProps>, ...args: any[]);
+
+        _init(...args: any[]): void;
+
+        static ['new'](path: string): Cutout;
+
+        // Methods
+
+        /**
+         * Gets the bounding box of the cutout.
+         * @returns The bounding box.
+         */
+        get_bounds(): Rect;
+        /**
+         * The name of the cutout.
+         * @returns The cutout's name.
+         */
+        get_name(): string;
+        /**
+         * Gets the SVG path describing the shape of the cutout.
+         * @returns The cutout's shape as SVG path
+         */
+        get_path(): string;
+    }
+
+    module DeviceInfo {
+        // Constructor properties interface
+
+        interface ConstructorProps extends GObject.Object.ConstructorProps {
+            compatibles: string[];
+        }
+    }
+
+    /**
+     * Get device dependent information.
+     *
+     * Allows to query device dependent information from different
+     * sources (currently we only look a the built-in gresources).
+     *
+     * The lookups are currently based on device tree compatibles.
+     * See [func`device_tree_get_compatibles]`.
+     */
+    class DeviceInfo extends GObject.Object {
+        static $gtype: GObject.GType<DeviceInfo>;
+
+        // Properties
+
+        /**
+         * The compatibles to look up device information for.
+         */
+        get compatibles(): string[];
+
+        // Constructors
+
+        constructor(properties?: Partial<DeviceInfo.ConstructorProps>, ...args: any[]);
+
+        _init(...args: any[]): void;
+
+        static ['new'](compatibles: string): DeviceInfo;
+
+        // Methods
+
+        /**
+         * Gets display panel information. Queries the database for the best
+         * matching panel based on the device's compatibles.
+         * @returns The display panel information
+         */
+        get_display_panel(): DisplayPanel;
+    }
+
+    module DisplayPanel {
+        // Constructor properties interface
+
+        interface ConstructorProps extends GObject.Object.ConstructorProps {
+            border_radius: number;
+            borderRadius: number;
+            cutouts: Gio.ListStore;
+            height: number;
+            name: string;
+            width: number;
+            x_res: number;
+            xRes: number;
+            y_res: number;
+            yRes: number;
+        }
+    }
+
+    /**
+     * Physical properties of a display panel like size, cutouts and
+     * rounded corners.
+     */
+    class DisplayPanel extends GObject.Object {
+        static $gtype: GObject.GType<DisplayPanel>;
+
+        // Properties
+
+        /**
+         * The border radius of the panel edges in device pixels
+         * If a single border radius isn't enough use multiple [type`Cutout]`.
+         */
+        get border_radius(): number;
+        set border_radius(val: number);
+        /**
+         * The border radius of the panel edges in device pixels
+         * If a single border radius isn't enough use multiple [type`Cutout]`.
+         */
+        get borderRadius(): number;
+        set borderRadius(val: number);
+        /**
+         * The display cutouts as `GListModel` of [class`Cutout]`.
+         */
+        get cutouts(): Gio.ListStore;
+        set cutouts(val: Gio.ListStore);
+        /**
+         * The display height in millimeters
+         */
+        get height(): number;
+        set height(val: number);
+        /**
+         * The name of the display
+         */
+        get name(): string;
+        set name(val: string);
+        /**
+         * The display width in millimeters
+         */
+        get width(): number;
+        set width(val: number);
+        /**
+         * The panel resolution in pixels in the x direction
+         */
+        get x_res(): number;
+        set x_res(val: number);
+        /**
+         * The panel resolution in pixels in the x direction
+         */
+        get xRes(): number;
+        set xRes(val: number);
+        /**
+         * The panel resolution in pixels in the y direction
+         */
+        get y_res(): number;
+        set y_res(val: number);
+        /**
+         * The panel resolution in pixels in the y direction
+         */
+        get yRes(): number;
+        set yRes(val: number);
+
+        // Constructors
+
+        constructor(properties?: Partial<DisplayPanel.ConstructorProps>, ...args: any[]);
+
+        _init(...args: any[]): void;
+
+        static ['new'](): DisplayPanel;
+
+        static new_from_data(data: string): DisplayPanel;
+
+        static new_from_resource(resource_name: string): DisplayPanel;
+
+        // Methods
+
+        /**
+         * Gets the panels border radius. 0 indicates rectangular corners.  If
+         * given applies to all corners of the panel.
+         * @returns The panel's border radius.
+         */
+        get_border_radius(): number;
+        /**
+         * Get the display cutouts.
+         * @returns The display cutouts
+         */
+        get_cutouts(): Gio.ListModel;
+        /**
+         * Gets the panels height in mm.
+         * @returns The panel's height.
+         */
+        get_height(): number;
+        /**
+         * Gets the panel's name.
+         * @returns The panel's name
+         */
+        get_name(): string;
+        /**
+         * Gets the panels width in mm.
+         * @returns The panel's width.
+         */
+        get_width(): number;
+        /**
+         * Gets the panels resolution (in pixels) in the x direction
+         * @returns The x resolution.
+         */
+        get_x_res(): number;
+        /**
+         * Gets the panels resolution (in pixels) in the y direction.
+         * @returns The y resolution.
+         */
+        get_y_res(): number;
+    }
+
+    type CutoutClass = typeof Cutout;
+    type DeviceInfoClass = typeof DeviceInfo;
+    type DisplayPanelClass = typeof DisplayPanel;
+    /**
+     * A rectangle.
+     *
+     * Similar to GdkRectangle but we don't want to pull in gtk/gdk.
+     */
+    class Rect {
+        static $gtype: GObject.GType<Rect>;
+
+        // Fields
+
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+
+        // Constructors
+
+        constructor(
+            properties?: Partial<{
+                x: number;
+                y: number;
+                width: number;
+                height: number;
+            }>,
+        );
+        _init(...args: any[]): void;
+    }
+
+    /**
+     * Name of the imported GIR library
+     * `see` https://gitlab.gnome.org/GNOME/gjs/-/blob/master/gi/ns.cpp#L188
+     */
+    const __name__: string;
+    /**
+     * Version of the imported GIR library
+     * `see` https://gitlab.gnome.org/GNOME/gjs/-/blob/master/gi/ns.cpp#L189
+     */
+    const __version__: string;
+}
+
+export default Gm;
+
+// END

package/gm-0.js

@@ -0,0 +1,5 @@
+
+// @ts-expect-error
+import Gm from 'gi://Gm?version=0';
+export default Gm;
+

package/index.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Type Definitions for Gjs (https://gjs.guide/)
+ *
+ * These type definitions are automatically generated, do not edit them by hand.
+ * If you found a bug fix it in `ts-for-gir` or create a bug report on https://github.com/gjsify/ts-for-gir
+ *
+ * This template is used to generate the index.d.ts file of each GIR module like Gtk-4.0, GObject-2.0, ...
+ */
+
+import './gm-0-ambient.d.ts';
+
+import './gm-0-import.d.ts';
+
+import Gm from './gm-0.js';
+export default Gm;

package/index.js

@@ -0,0 +1,5 @@
+
+// @ts-expect-error
+import Gm from './gm-0.js';
+export default Gm;
+

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@girs/gm-0",
+  "version": "0.0.0-4.0.0-beta.16",
+  "description": "GJS TypeScript type definitions for Gm-0, generated from library version 0.0.0",
+  "type": "module",
+  "module": "gm-0.js",
+  "main": "gm-0.js",
+  "exports": {
+    "./ambient": {
+      "types": "./gm-0-ambient.d.ts",
+      "import": "./gm-0-ambient.js",
+      "default": "./gm-0-ambient.js"
+    },
+    "./import": {
+      "types": "./gm-0-import.d.ts",
+      "import": "./gm-0-import.js",
+      "default": "./gm-0-import.js"
+    },
+    "./gm-0": {
+      "types": "./gm-0.d.ts",
+      "import": "./gm-0.js",
+      "default": "./gm-0.js"
+    },
+    ".": {
+      "types": "./index.d.ts",
+      "import": "./index.js",
+      "default": "./index.js"
+    }
+  },
+  "scripts": {
+    "test": "tsc --project tsconfig.json"
+  },
+  "dependencies": {
+    "@girs/gio-2.0": "^2.82.0-4.0.0-beta.16",
+    "@girs/gjs": "^4.0.0-beta.16",
+    "@girs/glib-2.0": "^2.82.0-4.0.0-beta.16",
+    "@girs/gmodule-2.0": "^2.0.0-4.0.0-beta.16",
+    "@girs/gobject-2.0": "^2.82.0-4.0.0-beta.16"
+  },
+  "devDependencies": {
+    "typescript": "*"
+  },
+  "keywords": [
+    "Gir",
+    "TypeScript",
+    "types",
+    "GObject-Introspection",
+    "GJS",
+    "Gm-0"
+  ],
+  "author": "ts-for-gir",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/gjsify/ts-for-gir.git"
+  },
+  "bugs": {
+    "url": "https://github.com/gjsify/ts-for-gir/issues"
+  },
+  "homepage": "https://github.com/gjsify/types/tree/main/gm-0#readme"
+}

package/tsconfig.json

@@ -0,0 +1,23 @@
+{
+  "compilerOptions": {
+    // General settings for code interpretation
+    "target": "ESNext",
+    "module": "NodeNext",
+    "lib": ["ESNext"],
+    "types": [],
+    "experimentalDecorators": true,
+    "moduleResolution": "NodeNext",
+    "noEmit": true,
+    "noEmitOnError": false,
+    "baseUrl": "./",
+    "rootDir": ".",
+    // General settings for code generation
+    "removeComments": false,
+    "inlineSourceMap": false,
+    "inlineSources": false,
+    "newLine": "LF"
+  },
+  "include": ["./gm-0.d.ts"]
+}
+
+

package/typedoc.json

@@ -0,0 +1,7 @@
+{
+    "entryPoints": ["./gm-0.d.ts"],
+    "readme": "./README.md",
+    "name": "Gm-0",
+    "tsconfig": "./tsconfig.json"
+}
+