@girs/adw-1 1.4.0-3.2.2 → 1.4.0-3.2.5

package/README.md

@@ -5,7 +5,7 @@
 ![downloads/week](https://img.shields.io/npm/dw/@girs/adw-1)
 
 
-GJS TypeScript type definitions for Adw-1, generated from library version 1.4.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v3.2.2.
+GJS TypeScript type definitions for Adw-1, generated from library version 1.4.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v3.2.5.
 
 Building blocks for modern GNOME applications
 
@@ -82,6 +82,19 @@ Now you have also type support for this, too:
 const Adw = imports.gi.Adw;
 ```
 
+
+### 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/adw-1-ambient.d.ts

@@ -1,5 +1,4 @@
 
-
 declare module 'gi://Adw?version=1' {
     import Adw1 from '@girs/adw-1';
     export default Adw1;

package/adw-1-import.d.ts

@@ -1,5 +1,4 @@
 
-
 import Adw1 from '@girs/adw-1';
 
 declare global {

package/adw-1.d.cts

@@ -9759,7 +9759,7 @@ export module HeaderBar {
          * Whether the header bar can show the back button.
          * 
          * The back button will never be shown unless the header bar is placed inside an
-         * [class`NavigationView]`.
+         * [class`NavigationView]`. Usually, there is no reason to set this to `FALSE`.
          */
         show_back_button?: boolean | null
         /**
@@ -9838,7 +9838,7 @@ export interface HeaderBar extends Gtk.Accessible, Gtk.Buildable, Gtk.Constraint
      * Whether the header bar can show the back button.
      * 
      * The back button will never be shown unless the header bar is placed inside an
-     * [class`NavigationView]`.
+     * [class`NavigationView]`. Usually, there is no reason to set this to `FALSE`.
      */
     show_back_button: boolean
     /**
@@ -9967,7 +9967,7 @@ export interface HeaderBar extends Gtk.Accessible, Gtk.Buildable, Gtk.Constraint
      * Sets whether `self` can show the back button.
      * 
      * The back button will never be shown unless the header bar is placed inside an
-     * [class`NavigationView]`.
+     * [class`NavigationView]`. Usually, there is no reason to set it to `FALSE`.
      * @param show_back_button whether to show the back button
      */
     set_show_back_button(show_back_button: boolean): void
@@ -10173,9 +10173,9 @@ export interface HeaderBar extends Gtk.Accessible, Gtk.Buildable, Gtk.Constraint
  * When used together with [class`NavigationView]` or [class`NavigationSplitView]`,
  * it will also display a back button that can be used to go back to the previous
  * page. The button also has a context menu, allowing to pop multiple pages at
- * once, potentially across multiple navigation views. Set
+ * once, potentially across multiple navigation views. In rare scenarios, set
  * [property`HeaderBar:`show-back-button] to `FALSE` to disable the back button
- * if it's unwanted.
+ * if it's unwanted (e.g. in an extra header bar on the same page).
  * 
  * ## Split View Integration
  * 

package/adw-1.d.ts

@@ -9761,7 +9761,7 @@ module HeaderBar {
          * Whether the header bar can show the back button.
          * 
          * The back button will never be shown unless the header bar is placed inside an
-         * [class`NavigationView]`.
+         * [class`NavigationView]`. Usually, there is no reason to set this to `FALSE`.
          */
         show_back_button?: boolean | null
         /**
@@ -9840,7 +9840,7 @@ interface HeaderBar extends Gtk.Accessible, Gtk.Buildable, Gtk.ConstraintTarget
      * Whether the header bar can show the back button.
      * 
      * The back button will never be shown unless the header bar is placed inside an
-     * [class`NavigationView]`.
+     * [class`NavigationView]`. Usually, there is no reason to set this to `FALSE`.
      */
     show_back_button: boolean
     /**
@@ -9969,7 +9969,7 @@ interface HeaderBar extends Gtk.Accessible, Gtk.Buildable, Gtk.ConstraintTarget
      * Sets whether `self` can show the back button.
      * 
      * The back button will never be shown unless the header bar is placed inside an
-     * [class`NavigationView]`.
+     * [class`NavigationView]`. Usually, there is no reason to set it to `FALSE`.
      * @param show_back_button whether to show the back button
      */
     set_show_back_button(show_back_button: boolean): void
@@ -10175,9 +10175,9 @@ interface HeaderBar extends Gtk.Accessible, Gtk.Buildable, Gtk.ConstraintTarget
  * When used together with [class`NavigationView]` or [class`NavigationSplitView]`,
  * it will also display a back button that can be used to go back to the previous
  * page. The button also has a context menu, allowing to pop multiple pages at
- * once, potentially across multiple navigation views. Set
+ * once, potentially across multiple navigation views. In rare scenarios, set
  * [property`HeaderBar:`show-back-button] to `FALSE` to disable the back button
- * if it's unwanted.
+ * if it's unwanted (e.g. in an extra header bar on the same page).
  * 
  * ## Split View Integration
  * 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@girs/adw-1",
-  "version": "1.4.0-3.2.2",
+  "version": "1.4.0-3.2.5",
   "description": "GJS TypeScript type definitions for Adw-1, generated from library version 1.4.0",
   "type": "module",
   "module": "adw-1.js",
@@ -25,21 +25,21 @@
     "test:cjs": "NODE_OPTIONS=--max_old_space_size=9216 tsc --noEmit adw-1.d.cts"
   },
   "dependencies": {
-    "@girs/cairo-1.0": "^1.0.0-3.2.2",
-    "@girs/freetype2-2.0": "^2.0.0-3.2.2",
-    "@girs/gdk-4.0": "^4.0.0-3.2.2",
-    "@girs/gdkpixbuf-2.0": "^2.0.0-3.2.2",
-    "@girs/gio-2.0": "^2.77.0-3.2.2",
-    "@girs/gjs": "^3.2.2",
-    "@girs/glib-2.0": "^2.77.0-3.2.2",
-    "@girs/gmodule-2.0": "^2.0.0-3.2.2",
-    "@girs/gobject-2.0": "^2.77.0-3.2.2",
-    "@girs/graphene-1.0": "^1.0.0-3.2.2",
-    "@girs/gsk-4.0": "^4.0.0-3.2.2",
-    "@girs/gtk-4.0": "^4.12.0-3.2.2",
-    "@girs/harfbuzz-0.0": "^7.1.0-3.2.2",
-    "@girs/pango-1.0": "^1.51.0-3.2.2",
-    "@girs/pangocairo-1.0": "^1.0.0-3.2.2"
+    "@girs/cairo-1.0": "^1.0.0-3.2.5",
+    "@girs/freetype2-2.0": "^2.0.0-3.2.5",
+    "@girs/gdk-4.0": "^4.0.0-3.2.5",
+    "@girs/gdkpixbuf-2.0": "^2.0.0-3.2.5",
+    "@girs/gio-2.0": "^2.78.0-3.2.5",
+    "@girs/gjs": "^3.2.5",
+    "@girs/glib-2.0": "^2.78.0-3.2.5",
+    "@girs/gmodule-2.0": "^2.0.0-3.2.5",
+    "@girs/gobject-2.0": "^2.78.0-3.2.5",
+    "@girs/graphene-1.0": "^1.0.0-3.2.5",
+    "@girs/gsk-4.0": "^4.0.0-3.2.5",
+    "@girs/gtk-4.0": "^4.12.3-3.2.5",
+    "@girs/harfbuzz-0.0": "^8.2.1-3.2.5",
+    "@girs/pango-1.0": "^1.51.0-3.2.5",
+    "@girs/pangocairo-1.0": "^1.0.0-3.2.5"
   },
   "devDependencies": {
     "typescript": "*"