@girs/manette-1 1.0.0-4.0.0-beta.37

package/README.md

@@ -0,0 +1,85 @@
+
+# Manette-1
+
+![version](https://img.shields.io/npm/v/@girs/manette-1)
+![downloads/week](https://img.shields.io/npm/dw/@girs/manette-1)
+
+
+GJS TypeScript type definitions for Manette-1, generated from library version 1.0.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.0.0-beta.37.
+
+## Install
+
+To use this type definitions, install them with NPM:
+```bash
+npm install @girs/manette-1
+```
+
+## Usage
+
+You can import this package into your project like this:
+```ts
+import Manette from '@girs/manette-1';
+```
+
+### 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/manette-1` or `@girs/manette-1/ambient` in your `tsconfig` or entry point Typescript file:
+
+`index.ts`:
+```ts
+import '@girs/manette-1'
+```
+
+`tsconfig.json`:
+```json
+{
+  "compilerOptions": {
+    ...
+  },
+  "include": ["@girs/manette-1"],
+  ...
+}
+```
+
+Now you can import the ambient module with TypeScript support: 
+
+```ts
+import Manette from 'gi://Manette?version=1';
+```
+
+### 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/manette-1` or `@girs/manette-1/import` in your `tsconfig` or entry point Typescript file:
+
+`index.ts`:
+```ts
+import '@girs/manette-1'
+```
+
+`tsconfig.json`:
+```json
+{
+  "compilerOptions": {
+    ...
+  },
+  "include": ["@girs/manette-1"],
+  ...
+}
+```
+
+Now you have also type support for this, too:
+
+```ts
+const Manette = imports.gi.Manette;
+```
+
+### 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/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 './manette-1-ambient.d.ts';
+
+import './manette-1-import.d.ts';
+
+import Manette from './manette-1.js';
+export default Manette;

package/index.js

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

package/manette-1-ambient.d.ts

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

package/manette-1-ambient.js

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

package/manette-1-import.d.ts

@@ -0,0 +1,9 @@
+import type Manette1 from '@girs/manette-1';
+
+declare global {
+    export interface GjsGiImports {
+        Manette: typeof Manette1;
+    }
+}
+
+export default GjsGiImports;

package/manette-1-import.js

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

package/manette-1.d.ts

@@ -0,0 +1,505 @@
+/**
+ * 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, ...
+ */
+
+import '@girs/gjs';
+
+// 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 Manette {
+    /**
+     * Manette-1
+     */
+
+    /**
+     * Describes available axes a [class`Device]` can have.
+     *
+     * More values may be added to this enumeration over time.
+     */
+
+    /**
+     * Describes available axes a [class`Device]` can have.
+     *
+     * More values may be added to this enumeration over time.
+     */
+    export namespace Axis {
+        export const $gtype: GObject.GType<Axis>;
+    }
+
+    enum Axis {
+        /**
+         * Left analog stick, horizontal axis
+         */
+        LEFT_X,
+        /**
+         * Left analog stick, vertical axis
+         */
+        LEFT_Y,
+        /**
+         * Right analog stick, horizontal axis
+         */
+        RIGHT_X,
+        /**
+         * Right analog stick, vertical axis
+         */
+        RIGHT_Y,
+        /**
+         * Left trigger (L2, LT or ZL)
+         */
+        LEFT_TRIGGER,
+        /**
+         * Right trigger (R2, RT or ZR)
+         */
+        RIGHT_TRIGGER,
+    }
+    /**
+     * Describes available buttons a [class`Device]` can have.
+     *
+     * More values may be added to this enumeration over time.
+     */
+
+    /**
+     * Describes available buttons a [class`Device]` can have.
+     *
+     * More values may be added to this enumeration over time.
+     */
+    export namespace Button {
+        export const $gtype: GObject.GType<Button>;
+    }
+
+    enum Button {
+        /**
+         * D-pad (up)
+         */
+        DPAD_UP,
+        /**
+         * D-pad (down)
+         */
+        DPAD_DOWN,
+        /**
+         * D-pad (left)
+         */
+        DPAD_LEFT,
+        /**
+         * D-pad (right)
+         */
+        DPAD_RIGHT,
+        /**
+         * Top face button
+         *     (XBox Y, Nintendo X, PlayStation triangle)
+         */
+        NORTH,
+        /**
+         * Bottom face button
+         *     (XBox A, Nintendo B, PlayStation X)
+         */
+        SOUTH,
+        /**
+         * Left face button
+         *     (XBox X, Nintendo Y, PlayStation square)
+         */
+        WEST,
+        /**
+         * Right face button
+         *     (XBox B, Nintendo A, PlayStation circle)
+         */
+        EAST,
+        /**
+         * Left menu button
+         */
+        SELECT,
+        /**
+         * Right menu button
+         */
+        START,
+        /**
+         * Center menu button (Home, Guide, Steam etc)
+         */
+        MODE,
+        /**
+         * Left shoulder button (L, L1 or LB)
+         */
+        LEFT_SHOULDER,
+        /**
+         * Right shoulder button (R, R1 or RB)
+         */
+        RIGHT_SHOULDER,
+        /**
+         * Left stick
+         */
+        LEFT_STICK,
+        /**
+         * Right stick
+         */
+        RIGHT_STICK,
+        /**
+         * Upper left paddle
+         *     (Steam Deck L4 or XBox Elite P3)
+         */
+        LEFT_PADDLE1,
+        /**
+         * Lower left paddle
+         *     (Steam Deck L5 or XBox Elite P4)
+         */
+        LEFT_PADDLE2,
+        /**
+         * Upper right paddle
+         *     (Steam Deck R4 or XBox Elite P1)
+         */
+        RIGHT_PADDLE1,
+        /**
+         * Lower right paddle
+         *     (Steam Deck R5 or XBox Elite P2)
+         */
+        RIGHT_PADDLE2,
+        /**
+         * Additional button
+         *     (Steam Deck QAM button, Xbox Series X share button etc)
+         */
+        MISC1,
+        /**
+         * Additional button
+         */
+        MISC2,
+        /**
+         * Additional button
+         */
+        MISC3,
+        /**
+         * Additional button
+         */
+        MISC4,
+        /**
+         * Additional button
+         */
+        MISC5,
+        /**
+         * Additional button
+         */
+        MISC6,
+        /**
+         * PS4/PS5 touchpad button
+         */
+        TOUCHPAD,
+    }
+    /**
+     * Describes available types of a [class`Device]`.
+     *
+     * More values may be added to this enumeration over time.
+     */
+
+    /**
+     * Describes available types of a [class`Device]`.
+     *
+     * More values may be added to this enumeration over time.
+     */
+    export namespace DeviceType {
+        export const $gtype: GObject.GType<DeviceType>;
+    }
+
+    enum DeviceType {
+        /**
+         * Generic gamepads
+         */
+        GENERIC,
+        /**
+         * Steam Deck
+         */
+        STEAM_DECK,
+    }
+    /**
+     * libmanette major version component (e.g. 1 if the version is 1.2.3).
+     */
+    const MAJOR_VERSION: number;
+    /**
+     * libmanette micro version component (e.g. 3 if the version is 1.2.3).
+     */
+    const MICRO_VERSION: number;
+    /**
+     * libmanette minor version component (e.g. 2 if the version is 1.2.3).
+     */
+    const MINOR_VERSION: number;
+    /**
+     * libmanette version, encoded as a string, useful for printing and
+     * concatenation.
+     */
+    const VERSION_S: string;
+    /**
+     * Returns the major version number of the libmanette library.
+     *
+     * For example, in libmanette version 1.2.3 this is 1.
+     *
+     * This function is in the library, so it represents the libmanette library your
+     * code is running against. Contrast with the [const`MAJOR_VERSION]` constant,
+     * which represents the major version of the libmanette headers you have
+     * included when compiling your code.
+     * @returns the major version number of the libmanette library
+     */
+    function get_major_version(): number;
+    /**
+     * Returns the micro version number of the libmanette library.
+     *
+     * For example, in libmanette version 1.2.3 this is 3.
+     *
+     * This function is in the library, so it represents the libmanette library your
+     * code is running against. Contrast with the [const`MAJOR_VERSION]` constant,
+     * which represents the micro version of the libmanette headers you have
+     * included when compiling your code.
+     * @returns the micro version number of the libmanette library
+     */
+    function get_micro_version(): number;
+    /**
+     * Returns the minor version number of the libmanette library.
+     *
+     * For example, in libmanette version 1.2.3 this is 2.
+     *
+     * This function is in the library, so it represents the libmanette library your
+     * code is running against. Contrast with the [const`MAJOR_VERSION]` constant,
+     * which represents the minor version of the libmanette headers you have
+     * included when compiling your code.
+     * @returns the minor version number of the libmanette library
+     */
+    function get_minor_version(): number;
+    namespace Device {
+        // Signal signatures
+        interface SignalSignatures extends GObject.Object.SignalSignatures {
+            'absolute-axis-changed': (arg0: Axis, arg1: number) => void;
+            'button-pressed': (arg0: Button) => void;
+            'button-released': (arg0: Button) => void;
+            disconnected: () => void;
+            'unmapped-absolute-axis-changed': (arg0: number, arg1: number) => void;
+            'unmapped-button-pressed': (arg0: number) => void;
+            'unmapped-button-released': (arg0: number) => void;
+            'unmapped-hat-axis-changed': (arg0: number, arg1: number) => void;
+        }
+
+        // Constructor properties interface
+
+        interface ConstructorProps extends GObject.Object.ConstructorProps {}
+    }
+
+    /**
+     * An object representing a physical gamepad.
+     *
+     * See also: [class`Monitor]`.
+     */
+    class Device extends GObject.Object {
+        static $gtype: GObject.GType<Device>;
+
+        /**
+         * Compile-time signal type information.
+         *
+         * This instance property is generated only for TypeScript type checking.
+         * It is not defined at runtime and should not be accessed in JS code.
+         * @internal
+         */
+        $signals: Device.SignalSignatures;
+
+        // Constructors
+
+        constructor(properties?: Partial<Device.ConstructorProps>, ...args: any[]);
+
+        _init(...args: any[]): void;
+
+        // Signals
+
+        connect<K extends keyof Device.SignalSignatures>(
+            signal: K,
+            callback: GObject.SignalCallback<this, Device.SignalSignatures[K]>,
+        ): number;
+        connect(signal: string, callback: (...args: any[]) => any): number;
+        connect_after<K extends keyof Device.SignalSignatures>(
+            signal: K,
+            callback: GObject.SignalCallback<this, Device.SignalSignatures[K]>,
+        ): number;
+        connect_after(signal: string, callback: (...args: any[]) => any): number;
+        emit<K extends keyof Device.SignalSignatures>(
+            signal: K,
+            ...args: GObject.GjsParameters<Device.SignalSignatures[K]> extends [any, ...infer Q] ? Q : never
+        ): void;
+        emit(signal: string, ...args: any[]): void;
+
+        // Methods
+
+        /**
+         * Gets the timestamp of when the current event was emitted on `self`.
+         *
+         * Use this timestamp to ensure external factors such as synchronous disk writes
+         * don't influence your timing computations.
+         * @returns the timestamp of when the current event was emitted
+         */
+        get_current_event_time(): number;
+        /**
+         * Gets the device type of `self`.
+         * @returns the device type
+         */
+        get_device_type(): DeviceType;
+        /**
+         * Gets the identifier used by SDL mappings to discriminate game controller
+         * devices.
+         * @returns the identifier used by SDL mappings
+         */
+        get_guid(): string;
+        /**
+         * Gets the user mapping for `self,` or default mapping if there isn't any.
+         *
+         * Can return `NULL` if there's no mapping or `self` doesn't support mappings.
+         * @returns the mapping for @self
+         */
+        get_mapping(): string | null;
+        /**
+         * Gets the device's name.
+         * @returns the name of @self
+         */
+        get_name(): string;
+        /**
+         * Gets whether the device has `axis`.
+         * @param axis an axis
+         * @returns whether the device has @axis
+         */
+        has_axis(axis: Axis | null): boolean;
+        /**
+         * Gets whether the device has `button`.
+         * @param button a button
+         * @returns whether the device has @button
+         */
+        has_button(button: Button | null): boolean;
+        /**
+         * Gets whether the device has the given input.
+         *
+         * If the input is present, it means that the device can send events for it
+         * regardless of whether the device is mapped or not.
+         * @param type the input type
+         * @param code the input code
+         * @returns whether the device has the given input
+         */
+        has_input(type: number, code: number): boolean;
+        /**
+         * Gets whether `self` supports rumble.
+         * @returns whether @self supports rumble
+         */
+        has_rumble(): boolean;
+        /**
+         * Gets whether `self` has a user mapping.
+         * @returns whether @self has a user mapping
+         */
+        has_user_mapping(): boolean;
+        /**
+         * Removes the user mapping for `self`.
+         */
+        remove_user_mapping(): void;
+        /**
+         * Make `self` rumble during `milliseconds` milliseconds.
+         *
+         * The heavy and light motors will rumble at their respectively defined
+         * magnitudes.
+         *
+         * The duration cannot exceed 32767 milliseconds.
+         * @param strong_magnitude the magnitude for the heavy motor
+         * @param weak_magnitude the magnitude for the light motor
+         * @param milliseconds the rumble effect play time in milliseconds
+         * @returns whether the rumble effect was played
+         */
+        rumble(strong_magnitude: number, weak_magnitude: number, milliseconds: number): boolean;
+        /**
+         * Saves `mapping_string` as the user mapping for `self`.
+         * @param mapping_string the mapping string
+         */
+        save_user_mapping(mapping_string: string): void;
+        /**
+         * Gets whether `self` supports mapping.
+         * @returns whether @self supports mapping
+         */
+        supports_mapping(): boolean;
+    }
+
+    namespace Monitor {
+        // Signal signatures
+        interface SignalSignatures extends GObject.Object.SignalSignatures {
+            'device-connected': (arg0: Device) => void;
+            'device-disconnected': (arg0: Device) => void;
+        }
+
+        // Constructor properties interface
+
+        interface ConstructorProps extends GObject.Object.ConstructorProps {}
+    }
+
+    /**
+     * An object monitoring the availability of devices.
+     *
+     * See also: [class`Device]`.
+     */
+    class Monitor extends GObject.Object {
+        static $gtype: GObject.GType<Monitor>;
+
+        /**
+         * Compile-time signal type information.
+         *
+         * This instance property is generated only for TypeScript type checking.
+         * It is not defined at runtime and should not be accessed in JS code.
+         * @internal
+         */
+        $signals: Monitor.SignalSignatures;
+
+        // Constructors
+
+        constructor(properties?: Partial<Monitor.ConstructorProps>, ...args: any[]);
+
+        _init(...args: any[]): void;
+
+        static ['new'](): Monitor;
+
+        // Signals
+
+        connect<K extends keyof Monitor.SignalSignatures>(
+            signal: K,
+            callback: GObject.SignalCallback<this, Monitor.SignalSignatures[K]>,
+        ): number;
+        connect(signal: string, callback: (...args: any[]) => any): number;
+        connect_after<K extends keyof Monitor.SignalSignatures>(
+            signal: K,
+            callback: GObject.SignalCallback<this, Monitor.SignalSignatures[K]>,
+        ): number;
+        connect_after(signal: string, callback: (...args: any[]) => any): number;
+        emit<K extends keyof Monitor.SignalSignatures>(
+            signal: K,
+            ...args: GObject.GjsParameters<Monitor.SignalSignatures[K]> extends [any, ...infer Q] ? Q : never
+        ): void;
+        emit(signal: string, ...args: any[]): void;
+
+        // Methods
+
+        /**
+         * Lists the currently connected devices.
+         * @returns the list of devices
+         */
+        list_devices(): Device[];
+    }
+
+    type DeviceClass = typeof Device;
+    type MonitorClass = typeof Monitor;
+    /**
+     * 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 Manette;
+
+// END

package/manette-1.js

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

package/package.json

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

package/tsconfig.json

@@ -0,0 +1,25 @@
+{
+  "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",
+    // Show diagnostics
+    "diagnostics": true
+  },
+  "include": ["./manette-1.d.ts"]
+}
+
+

package/typedoc.json

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