@girs/gdl-3 3.0.0-3.2.4 → 3.0.0-3.2.6

package/README.md

@@ -5,7 +5,7 @@
 ![downloads/week](https://img.shields.io/npm/dw/@girs/gdl-3)
 
 
-GJS TypeScript type definitions for Gdl-3, generated from library version 3.0.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v3.2.4.
+GJS TypeScript type definitions for Gdl-3, generated from library version 3.0.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v3.2.6.
 
 The GNOME Devtools Library package provides a docking system and several utilities useful to GNOME development tools and GNOME applications in general.
 
@@ -82,6 +82,19 @@ Now you have also type support for this, too:
 const Gdl = imports.gi.Gdl;
 ```
 
+
+### ESM vs. CommonJS
+
+GJS supports two different import syntaxes. The new modern ESM syntax and the old global imports syntax.
+
+In TypeScript projects for GJS and GNOME Shell extensions, you have the flexibility to use `ESM` syntax and then decide the import syntax for your bundled file. If your bundler is configured to use `CommonJS`, it will convert to the GJS-specific global imports syntax, like `const moduleName = imports.gi[moduleName]`. This is different from the traditional `require` syntax seen in Node.js. The global imports syntax is chosen because it aligns with the CommonJS format supported by NPM, which is used for the generated type definitions and this package.
+
+On the other hand, if you configure your bundler to use ESM, it will retain the ESM import syntax. It's crucial to ensure that your bundler is set up to correctly translate and bundle these imports into either CommonJS or ESM format, depending on your project's requirements.
+
+This approach is particularly important due to the `@girs` types, which include both `*.cjs `files, using the GJS global imports syntax, and `*.js` files, which utilize the ESM syntax. By appropriately setting up your bundler, you can control which syntax—CommonJS or ESM—is used in your project. The choice of CommonJS in this context is also due to the similarity between the GJS-specific global imports and CommonJS syntax, allowing for easier management and bundling in these specific types of projects.
+
+Since GNOME Shell 45, you should only use ESM, even for GNOME Shell extensions. Before that, extensions had to use the global import syntax, unlike normal GJS applications, where ESM has been available for some time.
+
 ### 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).

package/gdl-3-ambient.d.ts

@@ -1,5 +1,4 @@
 
-
 declare module 'gi://Gdl?version=3' {
     import Gdl3 from '@girs/gdl-3';
     export default Gdl3;

package/gdl-3-import.d.ts

@@ -1,5 +1,4 @@
 
-
 import Gdl3 from '@girs/gdl-3';
 
 declare global {

package/gdl-3.d.cts

@@ -283,6 +283,14 @@ export module Dock {
          */
         skip_taskbar?: boolean | null
         width?: number | null
+        defaultTitle?: string | null
+        /**
+         * Whether or not to prevent a floating dock window from appearing in the
+         * taskbar. Note that this only affects floating windows that are created
+         * after this flag is set; existing windows are not affected.  Usually,
+         * this property is used when you create the dock.
+         */
+        skipTaskbar?: boolean | null
     }
 
 }
@@ -292,6 +300,7 @@ export interface Dock extends Atk.ImplementorIface, Gtk.Buildable {
     // Own properties of Gdl-3.Gdl.Dock
 
     default_title: string | null
+    defaultTitle: string | null
     readonly floating: boolean
     floatx: number
     floaty: number
@@ -303,6 +312,13 @@ export interface Dock extends Atk.ImplementorIface, Gtk.Buildable {
      * this property is used when you create the dock.
      */
     skip_taskbar: boolean
+    /**
+     * Whether or not to prevent a floating dock window from appearing in the
+     * taskbar. Note that this only affects floating windows that are created
+     * after this flag is set; existing windows are not affected.  Usually,
+     * this property is used when you create the dock.
+     */
+    skipTaskbar: boolean
     width: number
 
     // Conflicting properties
@@ -727,6 +743,7 @@ export module DockBar {
          * The #GdlDockMaster object attached to the dockbar.
          */
         master?: GObject.Object | null
+        dockbarStyle?: DockBarStyle | null
     }
 
 }
@@ -736,6 +753,7 @@ export interface DockBar extends Atk.ImplementorIface, Gtk.Buildable, Gtk.Orient
     // Own properties of Gdl-3.Gdl.DockBar
 
     dockbar_style: DockBarStyle
+    dockbarStyle: DockBarStyle
     /**
      * The #GdlDockMaster object attached to the dockbar.
      */
@@ -1093,6 +1111,8 @@ export module DockItem {
         preferred_height?: number | null
         preferred_width?: number | null
         resize?: boolean | null
+        preferredHeight?: number | null
+        preferredWidth?: number | null
     }
 
 }
@@ -1122,7 +1142,9 @@ export interface DockItem extends Atk.ImplementorIface, Gtk.Buildable {
      */
     orientation: Gtk.Orientation
     preferred_height: number
+    preferredHeight: number
     preferred_width: number
+    preferredWidth: number
     resize: boolean
 
     // Conflicting properties
@@ -2290,6 +2312,10 @@ export module DockMaster {
         switcher_style?: SwitcherStyle | null
         tab_pos?: Gtk.PositionType | null
         tab_reorderable?: boolean | null
+        defaultTitle?: string | null
+        switcherStyle?: SwitcherStyle | null
+        tabPos?: Gtk.PositionType | null
+        tabReorderable?: boolean | null
     }
 
 }
@@ -2299,10 +2325,14 @@ export interface DockMaster {
     // Own properties of Gdl-3.Gdl.DockMaster
 
     default_title: string | null
+    defaultTitle: string | null
     locked: number
     switcher_style: SwitcherStyle
+    switcherStyle: SwitcherStyle
     tab_pos: Gtk.PositionType
+    tabPos: Gtk.PositionType
     tab_reorderable: boolean
+    tabReorderable: boolean
 
     // Own fields of Gdl-3.Gdl.DockMaster
 
@@ -2831,6 +2861,18 @@ export module DockObject {
          * A stock id to use for the icon of the dock object.
          */
         stock_id?: string | null
+        /**
+         * A long descriptive name.
+         */
+        longName?: string | null
+        /**
+         * A GdkPixbuf to use for the icon of the dock object.
+         */
+        pixbufIcon?: any | null
+        /**
+         * A stock id to use for the icon of the dock object.
+         */
+        stockId?: string | null
     }
 
 }
@@ -2843,6 +2885,10 @@ export interface DockObject extends Atk.ImplementorIface, Gtk.Buildable {
      * A long descriptive name.
      */
     long_name: string | null
+    /**
+     * A long descriptive name.
+     */
+    longName: string | null
     /**
      * The master which manages all the objects in a dock ring
      */
@@ -2856,10 +2902,18 @@ export interface DockObject extends Atk.ImplementorIface, Gtk.Buildable {
      * A GdkPixbuf to use for the icon of the dock object.
      */
     pixbuf_icon: any
+    /**
+     * A GdkPixbuf to use for the icon of the dock object.
+     */
+    pixbufIcon: any
     /**
      * A stock id to use for the icon of the dock object.
      */
     stock_id: string | null
+    /**
+     * A stock id to use for the icon of the dock object.
+     */
+    stockId: string | null
 
     // Own fields of Gdl-3.Gdl.DockObject
 
@@ -3795,6 +3849,7 @@ export module DockPlaceholder {
         next_placement?: DockPlacement | null
         sticky?: boolean | null
         width?: number | null
+        nextPlacement?: DockPlacement | null
     }
 
 }
@@ -3809,6 +3864,7 @@ export interface DockPlaceholder extends Atk.ImplementorIface, Gtk.Buildable {
     height: number
     host: DockObject
     next_placement: DockPlacement
+    nextPlacement: DockPlacement
     readonly sticky: boolean
     width: number
 
@@ -4816,6 +4872,9 @@ export module Switcher {
         switcher_style?: SwitcherStyle | null
         tab_pos?: Gtk.PositionType | null
         tab_reorderable?: boolean | null
+        switcherStyle?: SwitcherStyle | null
+        tabPos?: Gtk.PositionType | null
+        tabReorderable?: boolean | null
     }
 
 }
@@ -4825,8 +4884,11 @@ export interface Switcher extends Atk.ImplementorIface, Gtk.Buildable {
     // Own properties of Gdl-3.Gdl.Switcher
 
     switcher_style: SwitcherStyle
+    switcherStyle: SwitcherStyle
     tab_pos: Gtk.PositionType
+    tabPos: Gtk.PositionType
     tab_reorderable: boolean
+    tabReorderable: boolean
 
     // Own fields of Gdl-3.Gdl.Switcher
 

package/gdl-3.d.ts

@@ -285,6 +285,14 @@ module Dock {
          */
         skip_taskbar?: boolean | null
         width?: number | null
+        defaultTitle?: string | null
+        /**
+         * Whether or not to prevent a floating dock window from appearing in the
+         * taskbar. Note that this only affects floating windows that are created
+         * after this flag is set; existing windows are not affected.  Usually,
+         * this property is used when you create the dock.
+         */
+        skipTaskbar?: boolean | null
     }
 
 }
@@ -294,6 +302,7 @@ interface Dock extends Atk.ImplementorIface, Gtk.Buildable {
     // Own properties of Gdl-3.Gdl.Dock
 
     default_title: string | null
+    defaultTitle: string | null
     readonly floating: boolean
     floatx: number
     floaty: number
@@ -305,6 +314,13 @@ interface Dock extends Atk.ImplementorIface, Gtk.Buildable {
      * this property is used when you create the dock.
      */
     skip_taskbar: boolean
+    /**
+     * Whether or not to prevent a floating dock window from appearing in the
+     * taskbar. Note that this only affects floating windows that are created
+     * after this flag is set; existing windows are not affected.  Usually,
+     * this property is used when you create the dock.
+     */
+    skipTaskbar: boolean
     width: number
 
     // Conflicting properties
@@ -729,6 +745,7 @@ module DockBar {
          * The #GdlDockMaster object attached to the dockbar.
          */
         master?: GObject.Object | null
+        dockbarStyle?: DockBarStyle | null
     }
 
 }
@@ -738,6 +755,7 @@ interface DockBar extends Atk.ImplementorIface, Gtk.Buildable, Gtk.Orientable {
     // Own properties of Gdl-3.Gdl.DockBar
 
     dockbar_style: DockBarStyle
+    dockbarStyle: DockBarStyle
     /**
      * The #GdlDockMaster object attached to the dockbar.
      */
@@ -1095,6 +1113,8 @@ module DockItem {
         preferred_height?: number | null
         preferred_width?: number | null
         resize?: boolean | null
+        preferredHeight?: number | null
+        preferredWidth?: number | null
     }
 
 }
@@ -1124,7 +1144,9 @@ interface DockItem extends Atk.ImplementorIface, Gtk.Buildable {
      */
     orientation: Gtk.Orientation
     preferred_height: number
+    preferredHeight: number
     preferred_width: number
+    preferredWidth: number
     resize: boolean
 
     // Conflicting properties
@@ -2292,6 +2314,10 @@ module DockMaster {
         switcher_style?: SwitcherStyle | null
         tab_pos?: Gtk.PositionType | null
         tab_reorderable?: boolean | null
+        defaultTitle?: string | null
+        switcherStyle?: SwitcherStyle | null
+        tabPos?: Gtk.PositionType | null
+        tabReorderable?: boolean | null
     }
 
 }
@@ -2301,10 +2327,14 @@ interface DockMaster {
     // Own properties of Gdl-3.Gdl.DockMaster
 
     default_title: string | null
+    defaultTitle: string | null
     locked: number
     switcher_style: SwitcherStyle
+    switcherStyle: SwitcherStyle
     tab_pos: Gtk.PositionType
+    tabPos: Gtk.PositionType
     tab_reorderable: boolean
+    tabReorderable: boolean
 
     // Own fields of Gdl-3.Gdl.DockMaster
 
@@ -2833,6 +2863,18 @@ module DockObject {
          * A stock id to use for the icon of the dock object.
          */
         stock_id?: string | null
+        /**
+         * A long descriptive name.
+         */
+        longName?: string | null
+        /**
+         * A GdkPixbuf to use for the icon of the dock object.
+         */
+        pixbufIcon?: any | null
+        /**
+         * A stock id to use for the icon of the dock object.
+         */
+        stockId?: string | null
     }
 
 }
@@ -2845,6 +2887,10 @@ interface DockObject extends Atk.ImplementorIface, Gtk.Buildable {
      * A long descriptive name.
      */
     long_name: string | null
+    /**
+     * A long descriptive name.
+     */
+    longName: string | null
     /**
      * The master which manages all the objects in a dock ring
      */
@@ -2858,10 +2904,18 @@ interface DockObject extends Atk.ImplementorIface, Gtk.Buildable {
      * A GdkPixbuf to use for the icon of the dock object.
      */
     pixbuf_icon: any
+    /**
+     * A GdkPixbuf to use for the icon of the dock object.
+     */
+    pixbufIcon: any
     /**
      * A stock id to use for the icon of the dock object.
      */
     stock_id: string | null
+    /**
+     * A stock id to use for the icon of the dock object.
+     */
+    stockId: string | null
 
     // Own fields of Gdl-3.Gdl.DockObject
 
@@ -3797,6 +3851,7 @@ module DockPlaceholder {
         next_placement?: DockPlacement | null
         sticky?: boolean | null
         width?: number | null
+        nextPlacement?: DockPlacement | null
     }
 
 }
@@ -3811,6 +3866,7 @@ interface DockPlaceholder extends Atk.ImplementorIface, Gtk.Buildable {
     height: number
     host: DockObject
     next_placement: DockPlacement
+    nextPlacement: DockPlacement
     readonly sticky: boolean
     width: number
 
@@ -4818,6 +4874,9 @@ module Switcher {
         switcher_style?: SwitcherStyle | null
         tab_pos?: Gtk.PositionType | null
         tab_reorderable?: boolean | null
+        switcherStyle?: SwitcherStyle | null
+        tabPos?: Gtk.PositionType | null
+        tabReorderable?: boolean | null
     }
 
 }
@@ -4827,8 +4886,11 @@ interface Switcher extends Atk.ImplementorIface, Gtk.Buildable {
     // Own properties of Gdl-3.Gdl.Switcher
 
     switcher_style: SwitcherStyle
+    switcherStyle: SwitcherStyle
     tab_pos: Gtk.PositionType
+    tabPos: Gtk.PositionType
     tab_reorderable: boolean
+    tabReorderable: boolean
 
     // Own fields of Gdl-3.Gdl.Switcher
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@girs/gdl-3",
-  "version": "3.0.0-3.2.4",
+  "version": "3.0.0-3.2.6",
   "description": "GJS TypeScript type definitions for Gdl-3, generated from library version 3.0.0",
   "type": "module",
   "module": "gdl-3.js",
@@ -25,20 +25,20 @@
     "test:cjs": "NODE_OPTIONS=--max_old_space_size=9216 tsc --noEmit gdl-3.d.cts"
   },
   "dependencies": {
-    "@girs/atk-1.0": "^2.50.0-3.2.4",
-    "@girs/cairo-1.0": "^1.0.0-3.2.4",
-    "@girs/freetype2-2.0": "^2.0.0-3.2.4",
-    "@girs/gdk-3.0": "^3.24.38-3.2.4",
-    "@girs/gdkpixbuf-2.0": "^2.0.0-3.2.4",
-    "@girs/gio-2.0": "^2.78.0-3.2.4",
-    "@girs/gjs": "^3.2.4",
-    "@girs/glib-2.0": "^2.78.0-3.2.4",
-    "@girs/gmodule-2.0": "^2.0.0-3.2.4",
-    "@girs/gobject-2.0": "^2.78.0-3.2.4",
-    "@girs/gtk-3.0": "^3.24.38-3.2.4",
-    "@girs/harfbuzz-0.0": "^8.2.1-3.2.4",
-    "@girs/pango-1.0": "^1.51.0-3.2.4",
-    "@girs/xlib-2.0": "^2.0.0-3.2.4"
+    "@girs/atk-1.0": "^2.50.0-3.2.6",
+    "@girs/cairo-1.0": "^1.0.0-3.2.6",
+    "@girs/freetype2-2.0": "^2.0.0-3.2.6",
+    "@girs/gdk-3.0": "^3.24.38-3.2.6",
+    "@girs/gdkpixbuf-2.0": "^2.0.0-3.2.6",
+    "@girs/gio-2.0": "^2.78.0-3.2.6",
+    "@girs/gjs": "^3.2.6",
+    "@girs/glib-2.0": "^2.78.0-3.2.6",
+    "@girs/gmodule-2.0": "^2.0.0-3.2.6",
+    "@girs/gobject-2.0": "^2.78.0-3.2.6",
+    "@girs/gtk-3.0": "^3.24.38-3.2.6",
+    "@girs/harfbuzz-0.0": "^8.2.1-3.2.6",
+    "@girs/pango-1.0": "^1.51.0-3.2.6",
+    "@girs/xlib-2.0": "^2.0.0-3.2.6"
   },
   "devDependencies": {
     "typescript": "*"