@girs/builder-1.0 1.0.0-3.2.4 → 1.0.0-3.2.6

package/README.md

@@ -5,7 +5,7 @@
 ![downloads/week](https://img.shields.io/npm/dw/@girs/builder-1.0)
 
 
-GJS TypeScript type definitions for Builder-1.0, generated from library version 1.0.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v3.2.4.
+GJS TypeScript type definitions for Builder-1.0, generated from library version 1.0.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v3.2.6.
 
 
 ## Install
@@ -81,6 +81,19 @@ Now you have also type support for this, too:
 const Builder = imports.gi.Builder;
 ```
 
+
+### 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/builder-1.0-ambient.d.ts

@@ -1,5 +1,4 @@
 
-
 declare module 'gi://Builder?version=1.0' {
     import Builder10 from '@girs/builder-1.0';
     export default Builder10;

package/builder-1.0-import.d.ts

@@ -1,5 +1,4 @@
 
-
 import Builder10 from '@girs/builder-1.0';
 
 declare global {

package/builder-1.0.d.cts

@@ -137,6 +137,7 @@ export interface Document {
 
     readonly modified: boolean
     readonly read_only: boolean
+    readonly readOnly: boolean
     readonly title: string | null
 
     // Owm methods of Builder-1.0.Builder.Document
@@ -726,6 +727,7 @@ export module Tree {
         root?: TreeNode | null
         selection?: TreeNode | null
         show_icons?: boolean | null
+        showIcons?: boolean | null
     }
 
 }
@@ -737,6 +739,7 @@ export interface Tree extends Atk.ImplementorIface, Gtk.Buildable, Gtk.Scrollabl
     root: TreeNode
     selection: TreeNode
     show_icons: boolean
+    showIcons: boolean
 
     // Own fields of Builder-1.0.Builder.Tree
 
@@ -1262,6 +1265,27 @@ export module TreeNode {
          * If the "text" property includes #GMarkup.
          */
         use_markup?: boolean | null
+        /**
+         * This property allows for more lazy loading of nodes.
+         * 
+         * When a node becomes visible, we normally build it's children nodes
+         * so that we know if we need an expansion arrow. However, that can
+         * be expensive when rendering directories with lots of subdirectories.
+         * 
+         * Using this, you can always show an arrow without building the children
+         * and simply hide the arrow if there were in fact no children (upon
+         * expansion).
+         */
+        childrenPossible?: boolean | null
+        /**
+         * An icon-name to display on the row.
+         */
+        iconName?: string | null
+        useDimLabel?: boolean | null
+        /**
+         * If the "text" property includes #GMarkup.
+         */
+        useMarkup?: boolean | null
     }
 
 }
@@ -1282,10 +1306,26 @@ export interface TreeNode {
      * expansion).
      */
     children_possible: boolean
+    /**
+     * This property allows for more lazy loading of nodes.
+     * 
+     * When a node becomes visible, we normally build it's children nodes
+     * so that we know if we need an expansion arrow. However, that can
+     * be expensive when rendering directories with lots of subdirectories.
+     * 
+     * Using this, you can always show an arrow without building the children
+     * and simply hide the arrow if there were in fact no children (upon
+     * expansion).
+     */
+    childrenPossible: boolean
     /**
      * An icon-name to display on the row.
      */
     icon_name: string | null
+    /**
+     * An icon-name to display on the row.
+     */
+    iconName: string | null
     /**
      * An optional #GObject to associate with the node.
      */
@@ -1303,10 +1343,15 @@ export interface TreeNode {
      */
     tree: Tree
     use_dim_label: boolean
+    useDimLabel: boolean
     /**
      * If the "text" property includes #GMarkup.
      */
     use_markup: boolean
+    /**
+     * If the "text" property includes #GMarkup.
+     */
+    useMarkup: boolean
 
     // Owm methods of Builder-1.0.Builder.TreeNode
 
@@ -1468,9 +1513,11 @@ export interface View extends Atk.ImplementorIface, Gtk.Buildable, Gtk.Orientabl
     // Own properties of Builder-1.0.Builder.View
 
     readonly can_split: boolean
+    readonly canSplit: boolean
     readonly document: Document
     readonly modified: boolean
     readonly special_title: string | null
+    readonly specialTitle: string | null
     readonly title: string | null
 
     // Own fields of Builder-1.0.Builder.View
@@ -2017,6 +2064,7 @@ export module ViewStack {
         // Own constructor properties of Builder-1.0.Builder.ViewStack
 
         active_view?: View | null
+        activeView?: View | null
     }
 
 }
@@ -2026,6 +2074,7 @@ export interface ViewStack extends Atk.ImplementorIface, Gtk.Buildable {
     // Own properties of Builder-1.0.Builder.ViewStack
 
     active_view: View
+    activeView: View
 
     // Owm methods of Builder-1.0.Builder.ViewStack
 
@@ -2294,6 +2343,7 @@ export interface Workbench extends Atk.ImplementorIface, Gio.ActionGroup, Gio.Ac
     // Own properties of Builder-1.0.Builder.Workbench
 
     readonly active_view: View
+    readonly activeView: View
     readonly building: boolean
     /**
      * The "context" property is the #IdeContext that shall be worked upon in

package/builder-1.0.d.ts

@@ -139,6 +139,7 @@ interface Document {
 
     readonly modified: boolean
     readonly read_only: boolean
+    readonly readOnly: boolean
     readonly title: string | null
 
     // Owm methods of Builder-1.0.Builder.Document
@@ -728,6 +729,7 @@ module Tree {
         root?: TreeNode | null
         selection?: TreeNode | null
         show_icons?: boolean | null
+        showIcons?: boolean | null
     }
 
 }
@@ -739,6 +741,7 @@ interface Tree extends Atk.ImplementorIface, Gtk.Buildable, Gtk.Scrollable {
     root: TreeNode
     selection: TreeNode
     show_icons: boolean
+    showIcons: boolean
 
     // Own fields of Builder-1.0.Builder.Tree
 
@@ -1264,6 +1267,27 @@ module TreeNode {
          * If the "text" property includes #GMarkup.
          */
         use_markup?: boolean | null
+        /**
+         * This property allows for more lazy loading of nodes.
+         * 
+         * When a node becomes visible, we normally build it's children nodes
+         * so that we know if we need an expansion arrow. However, that can
+         * be expensive when rendering directories with lots of subdirectories.
+         * 
+         * Using this, you can always show an arrow without building the children
+         * and simply hide the arrow if there were in fact no children (upon
+         * expansion).
+         */
+        childrenPossible?: boolean | null
+        /**
+         * An icon-name to display on the row.
+         */
+        iconName?: string | null
+        useDimLabel?: boolean | null
+        /**
+         * If the "text" property includes #GMarkup.
+         */
+        useMarkup?: boolean | null
     }
 
 }
@@ -1284,10 +1308,26 @@ interface TreeNode {
      * expansion).
      */
     children_possible: boolean
+    /**
+     * This property allows for more lazy loading of nodes.
+     * 
+     * When a node becomes visible, we normally build it's children nodes
+     * so that we know if we need an expansion arrow. However, that can
+     * be expensive when rendering directories with lots of subdirectories.
+     * 
+     * Using this, you can always show an arrow without building the children
+     * and simply hide the arrow if there were in fact no children (upon
+     * expansion).
+     */
+    childrenPossible: boolean
     /**
      * An icon-name to display on the row.
      */
     icon_name: string | null
+    /**
+     * An icon-name to display on the row.
+     */
+    iconName: string | null
     /**
      * An optional #GObject to associate with the node.
      */
@@ -1305,10 +1345,15 @@ interface TreeNode {
      */
     tree: Tree
     use_dim_label: boolean
+    useDimLabel: boolean
     /**
      * If the "text" property includes #GMarkup.
      */
     use_markup: boolean
+    /**
+     * If the "text" property includes #GMarkup.
+     */
+    useMarkup: boolean
 
     // Owm methods of Builder-1.0.Builder.TreeNode
 
@@ -1470,9 +1515,11 @@ interface View extends Atk.ImplementorIface, Gtk.Buildable, Gtk.Orientable {
     // Own properties of Builder-1.0.Builder.View
 
     readonly can_split: boolean
+    readonly canSplit: boolean
     readonly document: Document
     readonly modified: boolean
     readonly special_title: string | null
+    readonly specialTitle: string | null
     readonly title: string | null
 
     // Own fields of Builder-1.0.Builder.View
@@ -2019,6 +2066,7 @@ module ViewStack {
         // Own constructor properties of Builder-1.0.Builder.ViewStack
 
         active_view?: View | null
+        activeView?: View | null
     }
 
 }
@@ -2028,6 +2076,7 @@ interface ViewStack extends Atk.ImplementorIface, Gtk.Buildable {
     // Own properties of Builder-1.0.Builder.ViewStack
 
     active_view: View
+    activeView: View
 
     // Owm methods of Builder-1.0.Builder.ViewStack
 
@@ -2296,6 +2345,7 @@ interface Workbench extends Atk.ImplementorIface, Gio.ActionGroup, Gio.ActionMap
     // Own properties of Builder-1.0.Builder.Workbench
 
     readonly active_view: View
+    readonly activeView: View
     readonly building: boolean
     /**
      * The "context" property is the #IdeContext that shall be worked upon in

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@girs/builder-1.0",
-  "version": "1.0.0-3.2.4",
+  "version": "1.0.0-3.2.6",
   "description": "GJS TypeScript type definitions for Builder-1.0, generated from library version 1.0.0",
   "type": "module",
   "module": "builder-1.0.js",
@@ -25,27 +25,27 @@
     "test:cjs": "NODE_OPTIONS=--max_old_space_size=9216 tsc --noEmit builder-1.0.d.cts"
   },
   "dependencies": {
-    "@girs/atk-1.0": "^2.50.0-3.2.4",
-    "@girs/cairo-1.0": "^1.0.0-3.2.4",
-    "@girs/dazzle-1.0": "^3.44.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/girepository-2.0": "^1.78.1-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/gtksource-3.0": "^3.0.0-3.2.4",
-    "@girs/harfbuzz-0.0": "^8.2.1-3.2.4",
-    "@girs/ide-1.0": "^1.0.0-3.2.4",
-    "@girs/json-1.0": "^1.7.1-3.2.4",
-    "@girs/pango-1.0": "^1.51.0-3.2.4",
-    "@girs/peas-1.0": "^1.0.0-3.2.4",
-    "@girs/template-1.0": "^3.36.2-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/dazzle-1.0": "^3.44.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/girepository-2.0": "^1.78.1-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/gtksource-3.0": "^3.0.0-3.2.6",
+    "@girs/harfbuzz-0.0": "^8.2.1-3.2.6",
+    "@girs/ide-1.0": "^1.0.0-3.2.6",
+    "@girs/json-1.0": "^1.7.1-3.2.6",
+    "@girs/pango-1.0": "^1.51.0-3.2.6",
+    "@girs/peas-1.0": "^1.0.0-3.2.6",
+    "@girs/template-1.0": "^3.36.2-3.2.6",
+    "@girs/xlib-2.0": "^2.0.0-3.2.6"
   },
   "devDependencies": {
     "typescript": "*"