@girs/gobject-2.0 2.84.0-4.0.0-beta.23 → 2.84.2-4.0.0-beta.25

package/README.md

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

package/gobject-2.0.d.ts

@@ -13,9 +13,11 @@ import '@girs/gjs';
 import type GLib from '@girs/glib-2.0';
 
 export namespace GObject {
-    // A few things here are inspired by gi.ts
-    // See https://gitlab.gnome.org/ewlsh/gi.ts/-/blob/master/packages/lib/src/generators/dts/gobject.ts
-    // Copyright Evan Welsh
+    /**
+     * Obtain the parameters of a function type in a tuple.
+     * Note: This is a copy of the Parameters type from the TypeScript standard library to avoid name conflicts, as some GIR types define `Parameters` as a namespace.
+     */
+    export type GjsParameters<T extends (...args: any) => any> = T extends (...args: infer P) => any ? P : never;
 
     // __type__ forces all GTypes to not match structurally.
     export type GType<T = unknown> = {
@@ -231,6 +233,19 @@ export namespace GObject {
 
     export type Property<K extends ParamSpec> = K extends ParamSpec<infer T> ? T : any;
 
+    // Helper types for type-safe signal handling
+    export interface SignalSignatures {
+        /** Fallback for dynamic signals and type compatibility */
+        [signal: string]: (...args: any[]) => any;
+    }
+
+    /**
+     * Helper to prepend the emitter (`source`) to an existing callback type.
+     */
+    export type SignalCallback<Emitter, Fn> = Fn extends (...args: infer P) => infer R
+        ? (source: Emitter, ...args: P) => R
+        : never;
+
     // TODO: What about the generated class Closure
     export type TClosure<R = any, P = any> = (...args: P[]) => R;
 
@@ -1336,7 +1351,7 @@ export namespace GObject {
         name: string,
         nick: string | null,
         blurb: string | null,
-        default_value: number,
+        default_value: string,
         flags: ParamFlags | null,
     ): ParamSpec;
     /**
@@ -2925,6 +2940,15 @@ export namespace GObject {
         DEEP_DERIVABLE,
     }
     namespace Binding {
+        // Signal signatures
+        interface SignalSignatures extends Object.SignalSignatures {
+            'notify::flags': (pspec: ParamSpec) => void;
+            'notify::source': (pspec: ParamSpec) => void;
+            'notify::source-property': (pspec: ParamSpec) => void;
+            'notify::target': (pspec: ParamSpec) => void;
+            'notify::target-property': (pspec: ParamSpec) => void;
+        }
+
         // Constructor properties interface
 
         interface ConstructorProps extends Object.ConstructorProps {
@@ -3065,12 +3089,39 @@ export namespace GObject {
          */
         get targetProperty(): 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: Binding.SignalSignatures;
+
         // Constructors
 
         constructor(properties?: Partial<Binding.ConstructorProps>, ...args: any[]);
 
         _init(...args: any[]): void;
 
+        // Signals
+
+        connect<K extends keyof Binding.SignalSignatures>(
+            signal: K,
+            callback: SignalCallback<this, Binding.SignalSignatures[K]>,
+        ): number;
+        connect(signal: string, callback: (...args: any[]) => any): number;
+        connect_after<K extends keyof Binding.SignalSignatures>(
+            signal: K,
+            callback: SignalCallback<this, Binding.SignalSignatures[K]>,
+        ): number;
+        connect_after(signal: string, callback: (...args: any[]) => any): number;
+        emit<K extends keyof Binding.SignalSignatures>(
+            signal: K,
+            ...args: GjsParameters<Binding.SignalSignatures[K]> extends [any, ...infer Q] ? Q : never
+        ): void;
+        emit(signal: string, ...args: any[]): void;
+
         // Methods
 
         /**
@@ -3151,6 +3202,11 @@ export namespace GObject {
     }
 
     namespace BindingGroup {
+        // Signal signatures
+        interface SignalSignatures extends Object.SignalSignatures {
+            'notify::source': (pspec: ParamSpec) => void;
+        }
+
         // Constructor properties interface
 
         interface ConstructorProps extends Object.ConstructorProps {
@@ -3178,6 +3234,15 @@ export namespace GObject {
         get source(): Object;
         set source(val: Object);
 
+        /**
+         * 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: BindingGroup.SignalSignatures;
+
         // Constructors
 
         constructor(properties?: Partial<BindingGroup.ConstructorProps>, ...args: any[]);
@@ -3186,6 +3251,24 @@ export namespace GObject {
 
         static ['new'](): BindingGroup;
 
+        // Signals
+
+        connect<K extends keyof BindingGroup.SignalSignatures>(
+            signal: K,
+            callback: SignalCallback<this, BindingGroup.SignalSignatures[K]>,
+        ): number;
+        connect(signal: string, callback: (...args: any[]) => any): number;
+        connect_after<K extends keyof BindingGroup.SignalSignatures>(
+            signal: K,
+            callback: SignalCallback<this, BindingGroup.SignalSignatures[K]>,
+        ): number;
+        connect_after(signal: string, callback: (...args: any[]) => any): number;
+        emit<K extends keyof BindingGroup.SignalSignatures>(
+            signal: K,
+            ...args: GjsParameters<BindingGroup.SignalSignatures[K]> extends [any, ...infer Q] ? Q : never
+        ): void;
+        emit(signal: string, ...args: any[]): void;
+
         // Methods
 
         /**
@@ -3266,6 +3349,9 @@ export namespace GObject {
     }
 
     namespace InitiallyUnowned {
+        // Signal signatures
+        interface SignalSignatures extends Object.SignalSignatures {}
+
         // Constructor properties interface
 
         interface ConstructorProps extends Object.ConstructorProps {}
@@ -3280,18 +3366,44 @@ export namespace GObject {
     class InitiallyUnowned extends Object {
         static $gtype: GType<InitiallyUnowned>;
 
+        /**
+         * 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: InitiallyUnowned.SignalSignatures;
+
         // Constructors
 
         constructor(properties?: Partial<InitiallyUnowned.ConstructorProps>, ...args: any[]);
 
         _init(...args: any[]): void;
+
+        // Signals
+
+        connect<K extends keyof InitiallyUnowned.SignalSignatures>(
+            signal: K,
+            callback: SignalCallback<this, InitiallyUnowned.SignalSignatures[K]>,
+        ): number;
+        connect(signal: string, callback: (...args: any[]) => any): number;
+        connect_after<K extends keyof InitiallyUnowned.SignalSignatures>(
+            signal: K,
+            callback: SignalCallback<this, InitiallyUnowned.SignalSignatures[K]>,
+        ): number;
+        connect_after(signal: string, callback: (...args: any[]) => any): number;
+        emit<K extends keyof InitiallyUnowned.SignalSignatures>(
+            signal: K,
+            ...args: GjsParameters<InitiallyUnowned.SignalSignatures[K]> extends [any, ...infer Q] ? Q : never
+        ): void;
+        emit(signal: string, ...args: any[]): void;
     }
 
     namespace Object {
-        // Signal callback interfaces
-
-        interface Notify {
-            (pspec: ParamSpec): void;
+        // Signal signatures
+        interface SignalSignatures {
+            notify: (arg0: ParamSpec) => void;
         }
 
         // Constructor properties interface
@@ -3326,6 +3438,15 @@ export namespace GObject {
     class Object {
         static $gtype: GType<Object>;
 
+        /**
+         * 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: Object.SignalSignatures;
+
         // Constructors
 
         _init(...args: any[]): void;
@@ -3334,12 +3455,21 @@ export namespace GObject {
 
         // 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: 'notify', callback: (_source: this, pspec: ParamSpec) => void): number;
-        connect_after(signal: 'notify', callback: (_source: this, pspec: ParamSpec) => void): number;
-        emit(signal: 'notify', pspec: ParamSpec): void;
+        connect<K extends keyof Object.SignalSignatures>(
+            signal: K,
+            callback: SignalCallback<this, Object.SignalSignatures[K]>,
+        ): number;
+        connect(signal: string, callback: (...args: any[]) => any): number;
+        connect_after<K extends keyof Object.SignalSignatures>(
+            signal: K,
+            callback: SignalCallback<this, Object.SignalSignatures[K]>,
+        ): number;
+        connect_after(signal: string, callback: (...args: any[]) => any): number;
+        emit<K extends keyof Object.SignalSignatures>(
+            signal: K,
+            ...args: GjsParameters<Object.SignalSignatures[K]> extends [any, ...infer Q] ? Q : never
+        ): void;
+        emit(signal: string, ...args: any[]): void;
 
         // Static methods
 
@@ -3571,8 +3701,8 @@ export namespace GObject {
             target: Object,
             target_property: string,
             flags: BindingFlags | null,
-            transform_to: Closure,
-            transform_from: Closure,
+            transform_to: Closure | null,
+            transform_from: Closure | null,
         ): Binding;
         /**
          * This function is intended for #GObject implementations to re-enforce
@@ -3858,6 +3988,11 @@ export namespace GObject {
         stop_emission_by_name(detailedName: string): void;
     }
 
+    namespace ParamSpec {
+        // Signal signatures
+        interface SignalSignatures extends Object.SignalSignatures {}
+    }
+
     /**
      * A GObject parameter specification that defines property characteristics.
      * See https://gjs.guide/guides/gobject/basics.html#properties for more details.
@@ -3876,6 +4011,24 @@ export namespace GObject {
 
         _init(...args: any[]): void;
 
+        // Signals
+
+        connect<K extends keyof ParamSpec.SignalSignatures>(
+            signal: K,
+            callback: SignalCallback<this, ParamSpec.SignalSignatures[K]>,
+        ): number;
+        connect(signal: string, callback: (...args: any[]) => any): number;
+        connect_after<K extends keyof ParamSpec.SignalSignatures>(
+            signal: K,
+            callback: SignalCallback<this, ParamSpec.SignalSignatures[K]>,
+        ): number;
+        connect_after(signal: string, callback: (...args: any[]) => any): number;
+        emit<K extends keyof ParamSpec.SignalSignatures>(
+            signal: K,
+            ...args: GjsParameters<ParamSpec.SignalSignatures[K]> extends [any, ...infer Q] ? Q : never
+        ): void;
+        emit(signal: string, ...args: any[]): void;
+
         // Static methods
 
         /**
@@ -4308,14 +4461,12 @@ export namespace GObject {
     }
 
     namespace SignalGroup {
-        // Signal callback interfaces
-
-        interface Bind {
-            (instance: Object): void;
-        }
-
-        interface Unbind {
-            (): void;
+        // Signal signatures
+        interface SignalSignatures extends Object.SignalSignatures {
+            bind: (arg0: Object) => void;
+            unbind: () => void;
+            'notify::target': (pspec: ParamSpec) => void;
+            'notify::target-type': (pspec: ParamSpec) => void;
         }
 
         // Constructor properties interface
@@ -4367,6 +4518,15 @@ export namespace GObject {
          */
         get targetType(): GType;
 
+        /**
+         * 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: SignalGroup.SignalSignatures;
+
         // Constructors
 
         constructor(properties?: Partial<SignalGroup.ConstructorProps>, ...args: any[]);
@@ -4377,15 +4537,21 @@ export namespace GObject {
 
         // 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: 'bind', callback: (_source: this, instance: Object) => void): number;
-        connect_after(signal: 'bind', callback: (_source: this, instance: Object) => void): number;
-        emit(signal: 'bind', instance: Object): void;
-        connect(signal: 'unbind', callback: (_source: this) => void): number;
-        connect_after(signal: 'unbind', callback: (_source: this) => void): number;
-        emit(signal: 'unbind'): void;
+        connect<K extends keyof SignalGroup.SignalSignatures>(
+            signal: K,
+            callback: SignalCallback<this, SignalGroup.SignalSignatures[K]>,
+        ): number;
+        connect(signal: string, callback: (...args: any[]) => any): number;
+        connect_after<K extends keyof SignalGroup.SignalSignatures>(
+            signal: K,
+            callback: SignalCallback<this, SignalGroup.SignalSignatures[K]>,
+        ): number;
+        connect_after(signal: string, callback: (...args: any[]) => any): number;
+        emit<K extends keyof SignalGroup.SignalSignatures>(
+            signal: K,
+            ...args: GjsParameters<SignalGroup.SignalSignatures[K]> extends [any, ...infer Q] ? Q : never
+        ): void;
+        emit(signal: string, ...args: any[]): void;
 
         // Methods
 
@@ -4459,6 +4625,9 @@ export namespace GObject {
     }
 
     namespace TypeModule {
+        // Signal signatures
+        interface SignalSignatures extends Object.SignalSignatures {}
+
         // Constructor properties interface
 
         interface ConstructorProps extends Object.ConstructorProps, TypePlugin.ConstructorProps {}
@@ -4500,6 +4669,15 @@ export namespace GObject {
     abstract class TypeModule extends Object implements TypePlugin {
         static $gtype: GType<TypeModule>;
 
+        /**
+         * 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: TypeModule.SignalSignatures;
+
         // Fields
 
         use_count: number;
@@ -4513,6 +4691,24 @@ export namespace GObject {
 
         _init(...args: any[]): void;
 
+        // Signals
+
+        connect<K extends keyof TypeModule.SignalSignatures>(
+            signal: K,
+            callback: SignalCallback<this, TypeModule.SignalSignatures[K]>,
+        ): number;
+        connect(signal: string, callback: (...args: any[]) => any): number;
+        connect_after<K extends keyof TypeModule.SignalSignatures>(
+            signal: K,
+            callback: SignalCallback<this, TypeModule.SignalSignatures[K]>,
+        ): number;
+        connect_after(signal: string, callback: (...args: any[]) => any): number;
+        emit<K extends keyof TypeModule.SignalSignatures>(
+            signal: K,
+            ...args: GjsParameters<TypeModule.SignalSignatures[K]> extends [any, ...infer Q] ? Q : never
+        ): void;
+        emit(signal: string, ...args: any[]): void;
+
         // Virtual methods
 
         /**

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@girs/gobject-2.0",
-  "version": "2.84.0-4.0.0-beta.23",
-  "description": "GJS TypeScript type definitions for GObject-2.0, generated from library version 2.84.0",
+  "version": "2.84.2-4.0.0-beta.25",
+  "description": "GJS TypeScript type definitions for GObject-2.0, generated from library version 2.84.2",
   "type": "module",
   "module": "gobject-2.0.js",
   "main": "gobject-2.0.js",
@@ -31,8 +31,8 @@
     "test": "tsc --project tsconfig.json"
   },
   "dependencies": {
-    "@girs/gjs": "^4.0.0-beta.23",
-    "@girs/glib-2.0": "^2.84.0-4.0.0-beta.23"
+    "@girs/gjs": "^4.0.0-beta.25",
+    "@girs/glib-2.0": "^2.84.2-4.0.0-beta.25"
   },
   "devDependencies": {
     "typescript": "*"