@girs/glib-2.0 2.78.0-3.2.4 → 2.78.0-3.2.6

package/README.md

@@ -5,7 +5,7 @@
 ![downloads/week](https://img.shields.io/npm/dw/@girs/glib-2.0)
 
 
-GJS TypeScript type definitions for GLib-2.0, generated from library version 2.78.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v3.2.4.
+GJS TypeScript type definitions for GLib-2.0, generated from library version 2.78.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v3.2.6.
 
 GLib provides the core application building blocks for libraries and applications written in C. It provides the core object system used in GNOME, the main loop implementation, and a large set of utility functions for strings and common data structures.
 
@@ -82,6 +82,19 @@ Now you have also type support for this, too:
 const GLib = imports.gi.GLib;
 ```
 
+
+### 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/glib-2.0-ambient.d.ts

@@ -1,5 +1,4 @@
 
-
 declare module 'gi://GLib?version=2.0' {
     import GLib20 from '@girs/glib-2.0';
     export default GLib20;

package/glib-2.0-import.d.ts

@@ -1,5 +1,4 @@
 
-
 import GLib20 from '@girs/glib-2.0';
 
 declare global {

package/glib-2.0.d.cts

@@ -17895,6 +17895,11 @@ export interface MainLoop {
      * the result is zero, free the loop and free all associated memory.
      */
     unref(): void
+    /**
+     * Similar to `GLib.MainLoop.run` but return a Promise which resolves when the main loop ends, instead of blocking while the main loop runs.
+     * This helps avoid the situation where Promises never resolved if you didn't run the main loop inside a callback.
+     */
+    runAsync(): Promise<void>
 }
 
 /**

package/glib-2.0.d.ts

@@ -17897,6 +17897,11 @@ interface MainLoop {
      * the result is zero, free the loop and free all associated memory.
      */
     unref(): void
+    /**
+     * Similar to `GLib.MainLoop.run` but return a Promise which resolves when the main loop ends, instead of blocking while the main loop runs.
+     * This helps avoid the situation where Promises never resolved if you didn't run the main loop inside a callback.
+     */
+    runAsync(): Promise<void>
 }
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@girs/glib-2.0",
-  "version": "2.78.0-3.2.4",
+  "version": "2.78.0-3.2.6",
   "description": "GJS TypeScript type definitions for GLib-2.0, generated from library version 2.78.0",
   "type": "module",
   "module": "glib-2.0.js",
@@ -25,8 +25,8 @@
     "test:cjs": "NODE_OPTIONS=--max_old_space_size=9216 tsc --noEmit glib-2.0.d.cts"
   },
   "dependencies": {
-    "@girs/gjs": "^3.2.4",
-    "@girs/gobject-2.0": "^2.78.0-3.2.4"
+    "@girs/gjs": "^3.2.6",
+    "@girs/gobject-2.0": "^2.78.0-3.2.6"
   },
   "devDependencies": {
     "typescript": "*"