@girs/gepub-0.5 0.5.0-4.0.0-beta.21 → 0.5.0-4.0.0-beta.24

package/README.md

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

package/gepub-0.5.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 libxml2 from '@girs/libxml2-2.0';
 import type WebKit2 from '@girs/webkit2-4.0';
@@ -19,7 +21,7 @@ import type JavaScriptCore from '@girs/javascriptcore-4.0';
 import type Gtk from '@girs/gtk-3.0';
 import type xlib from '@girs/xlib-2.0';
 import type Gdk from '@girs/gdk-3.0';
-import type cairo from '@girs/cairo-1.0';
+import type cairo from 'cairo';
 import type Pango from '@girs/pango-1.0';
 import type HarfBuzz from '@girs/harfbuzz-0.0';
 import type freetype2 from '@girs/freetype2-2.0';
@@ -52,6 +54,13 @@ export namespace Gepub {
      */
     const META_TITLE: string;
     namespace Doc {
+        // Signal signatures
+        interface SignalSignatures extends GObject.Object.SignalSignatures {
+            'notify::file': (pspec: GObject.ParamSpec) => void;
+            'notify::page': (pspec: GObject.ParamSpec) => void;
+            'notify::path': (pspec: GObject.ParamSpec) => void;
+        }
+
         // Constructor properties interface
 
         interface ConstructorProps extends GObject.Object.ConstructorProps, Gio.Initable.ConstructorProps {
@@ -71,6 +80,15 @@ export namespace Gepub {
         set page(val: number);
         get path(): 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: Doc.SignalSignatures;
+
         // Constructors
 
         constructor(properties?: Partial<Doc.ConstructorProps>, ...args: any[]);
@@ -79,6 +97,24 @@ export namespace Gepub {
 
         static ['new'](path: string): Doc;
 
+        // Signals
+
+        connect<K extends keyof Doc.SignalSignatures>(
+            signal: K,
+            callback: GObject.SignalCallback<this, Doc.SignalSignatures[K]>,
+        ): number;
+        connect(signal: string, callback: (...args: any[]) => any): number;
+        connect_after<K extends keyof Doc.SignalSignatures>(
+            signal: K,
+            callback: GObject.SignalCallback<this, Doc.SignalSignatures[K]>,
+        ): number;
+        connect_after(signal: string, callback: (...args: any[]) => any): number;
+        emit<K extends keyof Doc.SignalSignatures>(
+            signal: K,
+            ...args: GObject.GjsParameters<Doc.SignalSignatures[K]> extends [any, ...infer Q] ? Q : never
+        ): void;
+        emit(signal: string, ...args: any[]): void;
+
         // Methods
 
         get_cover(): string;
@@ -123,7 +159,7 @@ export namespace Gepub {
          * If the object is not initialized, or initialization returns with an
          * error, then all operations on the object except g_object_ref() and
          * g_object_unref() are considered to be invalid, and have undefined
-         * behaviour. See the [introduction][ginitable] for more details.
+         * behaviour. See the [description][iface`Gio`.Initable#description] for more details.
          *
          * Callers should not assume that a class which implements #GInitable can be
          * initialized multiple times, unless the class explicitly documents itself as
@@ -166,7 +202,7 @@ export namespace Gepub {
          * If the object is not initialized, or initialization returns with an
          * error, then all operations on the object except g_object_ref() and
          * g_object_unref() are considered to be invalid, and have undefined
-         * behaviour. See the [introduction][ginitable] for more details.
+         * behaviour. See the [description][iface`Gio`.Initable#description] for more details.
          *
          * Callers should not assume that a class which implements #GInitable can be
          * initialized multiple times, unless the class explicitly documents itself as
@@ -306,7 +342,21 @@ export namespace Gepub {
          * @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().
@@ -434,7 +484,12 @@ export namespace Gepub {
          * @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.
@@ -584,14 +639,105 @@ export namespace Gepub {
          * @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 Widget {
+        // Signal signatures
+        interface SignalSignatures extends WebKit2.WebView.SignalSignatures {
+            'notify::doc': (pspec: GObject.ParamSpec) => void;
+            'notify::automation-presentation-type': (pspec: GObject.ParamSpec) => void;
+            'notify::camera-capture-state': (pspec: GObject.ParamSpec) => void;
+            'notify::default-content-security-policy': (pspec: GObject.ParamSpec) => void;
+            'notify::display-capture-state': (pspec: GObject.ParamSpec) => void;
+            'notify::editable': (pspec: GObject.ParamSpec) => void;
+            'notify::estimated-load-progress': (pspec: GObject.ParamSpec) => void;
+            'notify::favicon': (pspec: GObject.ParamSpec) => void;
+            'notify::is-controlled-by-automation': (pspec: GObject.ParamSpec) => void;
+            'notify::is-ephemeral': (pspec: GObject.ParamSpec) => void;
+            'notify::is-loading': (pspec: GObject.ParamSpec) => void;
+            'notify::is-muted': (pspec: GObject.ParamSpec) => void;
+            'notify::is-playing-audio': (pspec: GObject.ParamSpec) => void;
+            'notify::is-web-process-responsive': (pspec: GObject.ParamSpec) => void;
+            'notify::microphone-capture-state': (pspec: GObject.ParamSpec) => void;
+            'notify::page-id': (pspec: GObject.ParamSpec) => void;
+            'notify::related-view': (pspec: GObject.ParamSpec) => void;
+            'notify::settings': (pspec: GObject.ParamSpec) => void;
+            'notify::title': (pspec: GObject.ParamSpec) => void;
+            'notify::uri': (pspec: GObject.ParamSpec) => void;
+            'notify::user-content-manager': (pspec: GObject.ParamSpec) => void;
+            'notify::web-context': (pspec: GObject.ParamSpec) => void;
+            'notify::web-extension-mode': (pspec: GObject.ParamSpec) => void;
+            'notify::website-policies': (pspec: GObject.ParamSpec) => void;
+            'notify::zoom-level': (pspec: GObject.ParamSpec) => void;
+            'notify::border-width': (pspec: GObject.ParamSpec) => void;
+            'notify::child': (pspec: GObject.ParamSpec) => void;
+            'notify::resize-mode': (pspec: GObject.ParamSpec) => void;
+            'notify::app-paintable': (pspec: GObject.ParamSpec) => void;
+            'notify::can-default': (pspec: GObject.ParamSpec) => void;
+            'notify::can-focus': (pspec: GObject.ParamSpec) => void;
+            'notify::composite-child': (pspec: GObject.ParamSpec) => void;
+            'notify::double-buffered': (pspec: GObject.ParamSpec) => void;
+            'notify::events': (pspec: GObject.ParamSpec) => void;
+            'notify::expand': (pspec: GObject.ParamSpec) => void;
+            'notify::focus-on-click': (pspec: GObject.ParamSpec) => void;
+            'notify::halign': (pspec: GObject.ParamSpec) => void;
+            'notify::has-default': (pspec: GObject.ParamSpec) => void;
+            'notify::has-focus': (pspec: GObject.ParamSpec) => void;
+            'notify::has-tooltip': (pspec: GObject.ParamSpec) => void;
+            'notify::height-request': (pspec: GObject.ParamSpec) => void;
+            'notify::hexpand': (pspec: GObject.ParamSpec) => void;
+            'notify::hexpand-set': (pspec: GObject.ParamSpec) => void;
+            'notify::is-focus': (pspec: GObject.ParamSpec) => void;
+            'notify::margin': (pspec: GObject.ParamSpec) => void;
+            'notify::margin-bottom': (pspec: GObject.ParamSpec) => void;
+            'notify::margin-end': (pspec: GObject.ParamSpec) => void;
+            'notify::margin-left': (pspec: GObject.ParamSpec) => void;
+            'notify::margin-right': (pspec: GObject.ParamSpec) => void;
+            'notify::margin-start': (pspec: GObject.ParamSpec) => void;
+            'notify::margin-top': (pspec: GObject.ParamSpec) => void;
+            'notify::name': (pspec: GObject.ParamSpec) => void;
+            'notify::no-show-all': (pspec: GObject.ParamSpec) => void;
+            'notify::opacity': (pspec: GObject.ParamSpec) => void;
+            'notify::parent': (pspec: GObject.ParamSpec) => void;
+            'notify::receives-default': (pspec: GObject.ParamSpec) => void;
+            'notify::scale-factor': (pspec: GObject.ParamSpec) => void;
+            'notify::sensitive': (pspec: GObject.ParamSpec) => void;
+            'notify::style': (pspec: GObject.ParamSpec) => void;
+            'notify::tooltip-markup': (pspec: GObject.ParamSpec) => void;
+            'notify::tooltip-text': (pspec: GObject.ParamSpec) => void;
+            'notify::valign': (pspec: GObject.ParamSpec) => void;
+            'notify::vexpand': (pspec: GObject.ParamSpec) => void;
+            'notify::vexpand-set': (pspec: GObject.ParamSpec) => void;
+            'notify::visible': (pspec: GObject.ParamSpec) => void;
+            'notify::width-request': (pspec: GObject.ParamSpec) => void;
+            'notify::window': (pspec: GObject.ParamSpec) => void;
+        }
+
         // Constructor properties interface
 
         interface ConstructorProps
@@ -610,6 +756,15 @@ export namespace Gepub {
         get doc(): Doc;
         set doc(val: Doc);
 
+        /**
+         * 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: Widget.SignalSignatures;
+
         // Constructors
 
         constructor(properties?: Partial<Widget.ConstructorProps>, ...args: any[]);
@@ -618,6 +773,24 @@ export namespace Gepub {
 
         static ['new'](): Widget;
 
+        // Signals
+
+        connect<K extends keyof Widget.SignalSignatures>(
+            signal: K,
+            callback: GObject.SignalCallback<this, Widget.SignalSignatures[K]>,
+        ): number;
+        connect(signal: string, callback: (...args: any[]) => any): number;
+        connect_after<K extends keyof Widget.SignalSignatures>(
+            signal: K,
+            callback: GObject.SignalCallback<this, Widget.SignalSignatures[K]>,
+        ): number;
+        connect_after(signal: string, callback: (...args: any[]) => any): number;
+        emit<K extends keyof Widget.SignalSignatures>(
+            signal: K,
+            ...args: GObject.GjsParameters<Widget.SignalSignatures[K]> extends [any, ...infer Q] ? Q : never
+        ): void;
+        emit(signal: string, ...args: any[]): void;
+
         // Methods
 
         get_doc(): Doc;
@@ -745,7 +918,21 @@ export namespace Gepub {
          * @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().
@@ -873,7 +1060,12 @@ export namespace Gepub {
          * @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.
@@ -1023,11 +1215,31 @@ export namespace Gepub {
          * @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;
     }
 
     type DocClass = typeof Doc;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@girs/gepub-0.5",
-  "version": "0.5.0-4.0.0-beta.21",
+  "version": "0.5.0-4.0.0-beta.24",
   "description": "GJS TypeScript type definitions for Gepub-0.5, generated from library version 0.5.0",
   "type": "module",
   "module": "gepub-0.5.js",
@@ -31,24 +31,24 @@
     "test": "tsc --project tsconfig.json"
   },
   "dependencies": {
-    "@girs/atk-1.0": "^2.55.2-4.0.0-beta.21",
-    "@girs/cairo-1.0": "^1.0.0-4.0.0-beta.21",
-    "@girs/freetype2-2.0": "^2.0.0-4.0.0-beta.21",
-    "@girs/gdk-3.0": "^3.24.48-4.0.0-beta.21",
-    "@girs/gdkpixbuf-2.0": "^2.0.0-4.0.0-beta.21",
-    "@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/gtk-3.0": "^3.24.48-4.0.0-beta.21",
-    "@girs/harfbuzz-0.0": "^9.0.0-4.0.0-beta.21",
-    "@girs/javascriptcore-4.0": "^2.46.5-4.0.0-beta.21",
-    "@girs/libxml2-2.0": "^2.0.0-4.0.0-beta.21",
-    "@girs/pango-1.0": "^1.56.0-4.0.0-beta.21",
-    "@girs/soup-2.4": "^2.74.3-4.0.0-beta.21",
-    "@girs/webkit2-4.0": "^2.46.5-4.0.0-beta.21",
-    "@girs/xlib-2.0": "^2.0.0-4.0.0-beta.21"
+    "@girs/atk-1.0": "^2.56.2-4.0.0-beta.24",
+    "@girs/cairo-1.0": "^1.0.0-4.0.0-beta.24",
+    "@girs/freetype2-2.0": "^2.0.0-4.0.0-beta.24",
+    "@girs/gdk-3.0": "^3.24.50-4.0.0-beta.24",
+    "@girs/gdkpixbuf-2.0": "^2.0.0-4.0.0-beta.24",
+    "@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/gtk-3.0": "^3.24.50-4.0.0-beta.24",
+    "@girs/harfbuzz-0.0": "^10.4.0-4.0.0-beta.24",
+    "@girs/javascriptcore-4.0": "^2.47.2-4.0.0-beta.24",
+    "@girs/libxml2-2.0": "^2.0.0-4.0.0-beta.24",
+    "@girs/pango-1.0": "^1.56.4-4.0.0-beta.24",
+    "@girs/soup-2.4": "^2.74.3-4.0.0-beta.24",
+    "@girs/webkit2-4.0": "^2.47.2-4.0.0-beta.24",
+    "@girs/xlib-2.0": "^2.0.0-4.0.0-beta.24"
   },
   "devDependencies": {
     "typescript": "*"