@girs/fprint-2.0 2.0.0-4.0.0-beta.21 → 2.0.0-4.0.0-beta.24

package/README.md

@@ -5,7 +5,7 @@
 ![downloads/week](https://img.shields.io/npm/dw/@girs/fprint-2.0)
 
 
-GJS TypeScript type definitions for FPrint-2.0, generated from library version 2.0.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.0.0-beta.21.
+GJS TypeScript type definitions for FPrint-2.0, generated from library version 2.0.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.0.0-beta.24.
 
 
 ## Install

package/fprint-2.0.d.ts

@@ -7,6 +7,8 @@
  * 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';
@@ -329,14 +331,10 @@ export namespace FPrint {
         PRESENT,
     }
     namespace Context {
-        // Signal callback interfaces
-
-        interface DeviceAdded {
-            (device: Device): void;
-        }
-
-        interface DeviceRemoved {
-            (device: Device): void;
+        // Signal signatures
+        interface SignalSignatures extends GObject.Object.SignalSignatures {
+            'device-added': (arg0: Device) => void;
+            'device-removed': (arg0: Device) => void;
         }
 
         // Constructor properties interface
@@ -347,6 +345,15 @@ export namespace FPrint {
     class Context extends GObject.Object {
         static $gtype: GObject.GType<Context>;
 
+        /**
+         * 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: Context.SignalSignatures;
+
         // Constructors
 
         constructor(properties?: Partial<Context.ConstructorProps>, ...args: any[]);
@@ -357,15 +364,21 @@ export namespace FPrint {
 
         // Signals
 
-        connect(id: string, callback: (...args: any[]) => any): number;
-        connect_after(id: string, callback: (...args: any[]) => any): number;
-        emit(id: string, ...args: any[]): void;
-        connect(signal: 'device-added', callback: (_source: this, device: Device) => void): number;
-        connect_after(signal: 'device-added', callback: (_source: this, device: Device) => void): number;
-        emit(signal: 'device-added', device: Device): void;
-        connect(signal: 'device-removed', callback: (_source: this, device: Device) => void): number;
-        connect_after(signal: 'device-removed', callback: (_source: this, device: Device) => void): number;
-        emit(signal: 'device-removed', device: Device): void;
+        connect<K extends keyof Context.SignalSignatures>(
+            signal: K,
+            callback: GObject.SignalCallback<this, Context.SignalSignatures[K]>,
+        ): number;
+        connect(signal: string, callback: (...args: any[]) => any): number;
+        connect_after<K extends keyof Context.SignalSignatures>(
+            signal: K,
+            callback: GObject.SignalCallback<this, Context.SignalSignatures[K]>,
+        ): number;
+        connect_after(signal: string, callback: (...args: any[]) => any): number;
+        emit<K extends keyof Context.SignalSignatures>(
+            signal: K,
+            ...args: GObject.GjsParameters<Context.SignalSignatures[K]> extends [any, ...infer Q] ? Q : never
+        ): void;
+        emit(signal: string, ...args: any[]): void;
 
         // Virtual methods
 
@@ -396,10 +409,23 @@ export namespace FPrint {
     }
 
     namespace Device {
-        // Signal callback interfaces
-
-        interface Removed {
-            (): void;
+        // Signal signatures
+        interface SignalSignatures extends GObject.Object.SignalSignatures {
+            removed: () => void;
+            'notify::device-id': (pspec: GObject.ParamSpec) => void;
+            'notify::driver': (pspec: GObject.ParamSpec) => void;
+            'notify::finger-status': (pspec: GObject.ParamSpec) => void;
+            'notify::fpi-driver-data': (pspec: GObject.ParamSpec) => void;
+            'notify::fpi-environ': (pspec: GObject.ParamSpec) => void;
+            'notify::fpi-udev-data-hidraw': (pspec: GObject.ParamSpec) => void;
+            'notify::fpi-udev-data-spidev': (pspec: GObject.ParamSpec) => void;
+            'notify::fpi-usb-device': (pspec: GObject.ParamSpec) => void;
+            'notify::name': (pspec: GObject.ParamSpec) => void;
+            'notify::nr-enroll-stages': (pspec: GObject.ParamSpec) => void;
+            'notify::open': (pspec: GObject.ParamSpec) => void;
+            'notify::removed': (pspec: GObject.ParamSpec) => void;
+            'notify::scan-type': (pspec: GObject.ParamSpec) => void;
+            'notify::temperature': (pspec: GObject.ParamSpec) => void;
         }
 
         // Constructor properties interface
@@ -460,6 +486,15 @@ export namespace FPrint {
         get scanType(): ScanType;
         get temperature(): Temperature;
 
+        /**
+         * 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[]);
@@ -468,12 +503,21 @@ export namespace FPrint {
 
         // Signals
 
-        connect(id: string, callback: (...args: any[]) => any): number;
-        connect_after(id: string, callback: (...args: any[]) => any): number;
-        emit(id: string, ...args: any[]): void;
-        connect(signal: 'removed', callback: (_source: this) => void): number;
-        connect_after(signal: 'removed', callback: (_source: this) => void): number;
-        emit(signal: 'removed'): void;
+        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
 
@@ -1415,7 +1459,21 @@ export namespace FPrint {
          * @returns the data if found,          or %NULL if no such data exists.
          */
         get_data(key: string): any | null;
-        get_property(property_name: string): any;
+        /**
+         * Gets a property of an object.
+         *
+         * The value can be:
+         * - an empty GObject.Value initialized by G_VALUE_INIT, which will be automatically initialized with the expected type of the property (since GLib 2.60)
+         * - a GObject.Value initialized with the expected type of the property
+         * - a GObject.Value initialized with a type to which the expected type of the property can be transformed
+         *
+         * In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling GObject.Value.unset.
+         *
+         * Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.
+         * @param property_name The name of the property to get
+         * @param value Return location for the property value. Can be an empty GObject.Value initialized by G_VALUE_INIT (auto-initialized with expected type since GLib 2.60), a GObject.Value initialized with the expected property type, or a GObject.Value initialized with a transformable type
+         */
+        get_property(property_name: string, value: GObject.Value | any): any;
         /**
          * This function gets back user data pointers stored via
          * g_object_set_qdata().
@@ -1543,7 +1601,12 @@ export namespace FPrint {
          * @param data data to associate with that key
          */
         set_data(key: string, data?: any | null): void;
-        set_property(property_name: string, value: any): void;
+        /**
+         * Sets a property on an object.
+         * @param property_name The name of the property to set
+         * @param value The value to set the property to
+         */
+        set_property(property_name: string, value: GObject.Value | any): void;
         /**
          * Remove a specified datum from the object's data associations,
          * without invoking the association's destroy handler.
@@ -1693,14 +1756,40 @@ export namespace FPrint {
          * @param pspec
          */
         vfunc_set_property(property_id: number, value: GObject.Value | any, pspec: GObject.ParamSpec): void;
+        /**
+         * Disconnects a handler from an instance so it will not be called during any future or currently ongoing emissions of the signal it has been connected to.
+         * @param id Handler ID of the handler to be disconnected
+         */
         disconnect(id: number): void;
+        /**
+         * Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.
+         * @param properties Object containing the properties to set
+         */
         set(properties: { [key: string]: any }): void;
-        block_signal_handler(id: number): any;
-        unblock_signal_handler(id: number): any;
-        stop_emission_by_name(detailedName: string): any;
+        /**
+         * Blocks a handler of an instance so it will not be called during any signal emissions
+         * @param id Handler ID of the handler to be blocked
+         */
+        block_signal_handler(id: number): void;
+        /**
+         * Unblocks a handler so it will be called again during any signal emissions
+         * @param id Handler ID of the handler to be unblocked
+         */
+        unblock_signal_handler(id: number): void;
+        /**
+         * Stops a signal's emission by the given signal name. This will prevent the default handler and any subsequent signal handlers from being invoked.
+         * @param detailedName Name of the signal to stop emission of
+         */
+        stop_emission_by_name(detailedName: string): void;
     }
 
     namespace Image {
+        // Signal signatures
+        interface SignalSignatures extends GObject.Object.SignalSignatures {
+            'notify::height': (pspec: GObject.ParamSpec) => void;
+            'notify::width': (pspec: GObject.ParamSpec) => void;
+        }
+
         // Constructor properties interface
 
         interface ConstructorProps extends GObject.Object.ConstructorProps {
@@ -1717,6 +1806,15 @@ export namespace FPrint {
         get height(): number;
         get width(): number;
 
+        /**
+         * 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: Image.SignalSignatures;
+
         // Constructors
 
         constructor(properties?: Partial<Image.ConstructorProps>, ...args: any[]);
@@ -1725,6 +1823,24 @@ export namespace FPrint {
 
         static ['new'](width: number, height: number): Image;
 
+        // Signals
+
+        connect<K extends keyof Image.SignalSignatures>(
+            signal: K,
+            callback: GObject.SignalCallback<this, Image.SignalSignatures[K]>,
+        ): number;
+        connect(signal: string, callback: (...args: any[]) => any): number;
+        connect_after<K extends keyof Image.SignalSignatures>(
+            signal: K,
+            callback: GObject.SignalCallback<this, Image.SignalSignatures[K]>,
+        ): number;
+        connect_after(signal: string, callback: (...args: any[]) => any): number;
+        emit<K extends keyof Image.SignalSignatures>(
+            signal: K,
+            ...args: GObject.GjsParameters<Image.SignalSignatures[K]> extends [any, ...infer Q] ? Q : never
+        ): void;
+        emit(signal: string, ...args: any[]): void;
+
         // Methods
 
         /**
@@ -1794,10 +1910,23 @@ export namespace FPrint {
     }
 
     namespace ImageDevice {
-        // Signal callback interfaces
-
-        interface FpiImageDeviceStateChanged {
-            (new_state: unknown): void;
+        // Signal signatures
+        interface SignalSignatures extends Device.SignalSignatures {
+            'fpi-image-device-state-changed': (arg0: unknown) => void;
+            'notify::device-id': (pspec: GObject.ParamSpec) => void;
+            'notify::driver': (pspec: GObject.ParamSpec) => void;
+            'notify::finger-status': (pspec: GObject.ParamSpec) => void;
+            'notify::fpi-driver-data': (pspec: GObject.ParamSpec) => void;
+            'notify::fpi-environ': (pspec: GObject.ParamSpec) => void;
+            'notify::fpi-udev-data-hidraw': (pspec: GObject.ParamSpec) => void;
+            'notify::fpi-udev-data-spidev': (pspec: GObject.ParamSpec) => void;
+            'notify::fpi-usb-device': (pspec: GObject.ParamSpec) => void;
+            'notify::name': (pspec: GObject.ParamSpec) => void;
+            'notify::nr-enroll-stages': (pspec: GObject.ParamSpec) => void;
+            'notify::open': (pspec: GObject.ParamSpec) => void;
+            'notify::removed': (pspec: GObject.ParamSpec) => void;
+            'notify::scan-type': (pspec: GObject.ParamSpec) => void;
+            'notify::temperature': (pspec: GObject.ParamSpec) => void;
         }
 
         // Constructor properties interface
@@ -1808,6 +1937,15 @@ export namespace FPrint {
     abstract class ImageDevice extends Device implements Gio.AsyncInitable<ImageDevice> {
         static $gtype: GObject.GType<ImageDevice>;
 
+        /**
+         * 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: ImageDevice.SignalSignatures;
+
         // Constructors
 
         constructor(properties?: Partial<ImageDevice.ConstructorProps>, ...args: any[]);
@@ -1816,18 +1954,21 @@ export namespace FPrint {
 
         // Signals
 
-        connect(id: string, callback: (...args: any[]) => any): number;
-        connect_after(id: string, callback: (...args: any[]) => any): number;
-        emit(id: string, ...args: any[]): void;
-        connect(
-            signal: 'fpi-image-device-state-changed',
-            callback: (_source: this, new_state: unknown) => void,
+        connect<K extends keyof ImageDevice.SignalSignatures>(
+            signal: K,
+            callback: GObject.SignalCallback<this, ImageDevice.SignalSignatures[K]>,
         ): number;
-        connect_after(
-            signal: 'fpi-image-device-state-changed',
-            callback: (_source: this, new_state: unknown) => void,
+        connect(signal: string, callback: (...args: any[]) => any): number;
+        connect_after<K extends keyof ImageDevice.SignalSignatures>(
+            signal: K,
+            callback: GObject.SignalCallback<this, ImageDevice.SignalSignatures[K]>,
         ): number;
-        emit(signal: 'fpi-image-device-state-changed', new_state: unknown): void;
+        connect_after(signal: string, callback: (...args: any[]) => any): number;
+        emit<K extends keyof ImageDevice.SignalSignatures>(
+            signal: K,
+            ...args: GObject.GjsParameters<ImageDevice.SignalSignatures[K]> extends [any, ...infer Q] ? Q : never
+        ): void;
+        emit(signal: string, ...args: any[]): void;
 
         // Inherited methods
         /**
@@ -2146,7 +2287,21 @@ export namespace FPrint {
          * @returns the data if found,          or %NULL if no such data exists.
          */
         get_data(key: string): any | null;
-        get_property(property_name: string): any;
+        /**
+         * Gets a property of an object.
+         *
+         * The value can be:
+         * - an empty GObject.Value initialized by G_VALUE_INIT, which will be automatically initialized with the expected type of the property (since GLib 2.60)
+         * - a GObject.Value initialized with the expected type of the property
+         * - a GObject.Value initialized with a type to which the expected type of the property can be transformed
+         *
+         * In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling GObject.Value.unset.
+         *
+         * Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.
+         * @param property_name The name of the property to get
+         * @param value Return location for the property value. Can be an empty GObject.Value initialized by G_VALUE_INIT (auto-initialized with expected type since GLib 2.60), a GObject.Value initialized with the expected property type, or a GObject.Value initialized with a transformable type
+         */
+        get_property(property_name: string, value: GObject.Value | any): any;
         /**
          * This function gets back user data pointers stored via
          * g_object_set_qdata().
@@ -2274,7 +2429,12 @@ export namespace FPrint {
          * @param data data to associate with that key
          */
         set_data(key: string, data?: any | null): void;
-        set_property(property_name: string, value: any): void;
+        /**
+         * Sets a property on an object.
+         * @param property_name The name of the property to set
+         * @param value The value to set the property to
+         */
+        set_property(property_name: string, value: GObject.Value | any): void;
         /**
          * Remove a specified datum from the object's data associations,
          * without invoking the association's destroy handler.
@@ -2424,14 +2584,48 @@ export namespace FPrint {
          * @param pspec
          */
         vfunc_set_property(property_id: number, value: GObject.Value | any, pspec: GObject.ParamSpec): void;
+        /**
+         * Disconnects a handler from an instance so it will not be called during any future or currently ongoing emissions of the signal it has been connected to.
+         * @param id Handler ID of the handler to be disconnected
+         */
         disconnect(id: number): void;
+        /**
+         * Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.
+         * @param properties Object containing the properties to set
+         */
         set(properties: { [key: string]: any }): void;
-        block_signal_handler(id: number): any;
-        unblock_signal_handler(id: number): any;
-        stop_emission_by_name(detailedName: string): any;
+        /**
+         * Blocks a handler of an instance so it will not be called during any signal emissions
+         * @param id Handler ID of the handler to be blocked
+         */
+        block_signal_handler(id: number): void;
+        /**
+         * Unblocks a handler so it will be called again during any signal emissions
+         * @param id Handler ID of the handler to be unblocked
+         */
+        unblock_signal_handler(id: number): void;
+        /**
+         * Stops a signal's emission by the given signal name. This will prevent the default handler and any subsequent signal handlers from being invoked.
+         * @param detailedName Name of the signal to stop emission of
+         */
+        stop_emission_by_name(detailedName: string): void;
     }
 
     namespace Print {
+        // Signal signatures
+        interface SignalSignatures extends GObject.InitiallyUnowned.SignalSignatures {
+            'notify::description': (pspec: GObject.ParamSpec) => void;
+            'notify::device-id': (pspec: GObject.ParamSpec) => void;
+            'notify::device-stored': (pspec: GObject.ParamSpec) => void;
+            'notify::driver': (pspec: GObject.ParamSpec) => void;
+            'notify::enroll-date': (pspec: GObject.ParamSpec) => void;
+            'notify::finger': (pspec: GObject.ParamSpec) => void;
+            'notify::fpi-data': (pspec: GObject.ParamSpec) => void;
+            'notify::fpi-prints': (pspec: GObject.ParamSpec) => void;
+            'notify::image': (pspec: GObject.ParamSpec) => void;
+            'notify::username': (pspec: GObject.ParamSpec) => void;
+        }
+
         // Constructor properties interface
 
         interface ConstructorProps extends GObject.InitiallyUnowned.ConstructorProps {
@@ -2483,6 +2677,15 @@ export namespace FPrint {
         get username(): string;
         set username(val: string);
 
+        /**
+         * 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: Print.SignalSignatures;
+
         // Constructors
 
         constructor(properties?: Partial<Print.ConstructorProps>, ...args: any[]);
@@ -2491,6 +2694,24 @@ export namespace FPrint {
 
         static ['new'](device: Device): Print;
 
+        // Signals
+
+        connect<K extends keyof Print.SignalSignatures>(
+            signal: K,
+            callback: GObject.SignalCallback<this, Print.SignalSignatures[K]>,
+        ): number;
+        connect(signal: string, callback: (...args: any[]) => any): number;
+        connect_after<K extends keyof Print.SignalSignatures>(
+            signal: K,
+            callback: GObject.SignalCallback<this, Print.SignalSignatures[K]>,
+        ): number;
+        connect_after(signal: string, callback: (...args: any[]) => any): number;
+        emit<K extends keyof Print.SignalSignatures>(
+            signal: K,
+            ...args: GObject.GjsParameters<Print.SignalSignatures[K]> extends [any, ...infer Q] ? Q : never
+        ): void;
+        emit(signal: string, ...args: any[]): void;
+
         // Static methods
 
         /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@girs/fprint-2.0",
-  "version": "2.0.0-4.0.0-beta.21",
+  "version": "2.0.0-4.0.0-beta.24",
   "description": "GJS TypeScript type definitions for FPrint-2.0, generated from library version 2.0.0",
   "type": "module",
   "module": "fprint-2.0.js",
@@ -31,13 +31,13 @@
     "test": "tsc --project tsconfig.json"
   },
   "dependencies": {
-    "@girs/gio-2.0": "^2.83.3-4.0.0-beta.21",
-    "@girs/gjs": "^4.0.0-beta.21",
-    "@girs/glib-2.0": "^2.83.3-4.0.0-beta.21",
-    "@girs/gmodule-2.0": "^2.0.0-4.0.0-beta.21",
-    "@girs/gobject-2.0": "^2.83.3-4.0.0-beta.21",
-    "@girs/gusb-1.0": "^0.4.9-4.0.0-beta.21",
-    "@girs/json-1.0": "^1.10.7-4.0.0-beta.21"
+    "@girs/gio-2.0": "^2.84.2-4.0.0-beta.24",
+    "@girs/gjs": "^4.0.0-beta.24",
+    "@girs/glib-2.0": "^2.84.2-4.0.0-beta.24",
+    "@girs/gmodule-2.0": "^2.0.0-4.0.0-beta.24",
+    "@girs/gobject-2.0": "^2.84.2-4.0.0-beta.24",
+    "@girs/gusb-1.0": "^0.4.9-4.0.0-beta.24",
+    "@girs/json-1.0": "^1.10.7-4.0.0-beta.24"
   },
   "devDependencies": {
     "typescript": "*"