@girs/atk-1.0 2.48.3-3.2.3 → 2.50.0-3.2.5

package/README.md

@@ -5,7 +5,7 @@
 ![downloads/week](https://img.shields.io/npm/dw/@girs/atk-1.0)
 
 
-GJS TypeScript type definitions for Atk-1.0, generated from library version 2.48.3 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v3.2.3.
+GJS TypeScript type definitions for Atk-1.0, generated from library version 2.50.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v3.2.5.
 
 ATK provides the set of accessibility interfaces that are implemented by other toolkits and applications. Using the ATK interfaces, accessibility tools have full access to view and control running applications.
 
@@ -82,6 +82,19 @@ Now you have also type support for this, too:
 const Atk = imports.gi.Atk;
 ```
 
+
+### 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/atk-1.0-ambient.d.ts

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

package/atk-1.0-import.d.ts

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

package/atk-1.0.d.cts

@@ -93,6 +93,26 @@ export enum Layer {
      */
     WINDOW,
 }
+/**
+ * Enumeration used to indicate a type of live region and how assertive it
+ * should be in terms of speaking notifications. Currently, this is only used
+ * for "notification" events, but it may be used for additional purposes
+ * in the future.
+ */
+export enum Live {
+    /**
+     * No live region.
+     */
+    NONE,
+    /**
+     * This live region should be considered polite.
+     */
+    POLITE,
+    /**
+     * This live region should be considered assertive.
+     */
+    ASSERTIVE,
+}
 /**
  * Describes the type of the relation
  */
@@ -5900,6 +5920,13 @@ export module Object {
         ($obj: Object, arg1: boolean): void
     }
 
+    /**
+     * Signal callback interface for `notification`
+     */
+    export interface NotificationSignalCallback {
+        ($obj: Object, arg1: string | null, arg2: number): void
+    }
+
     /**
      * Signal callback interface for `property-change`
      */
@@ -6330,6 +6357,9 @@ export interface Object {
     connect(sigName: "focus-event", callback: Object.FocusEventSignalCallback): number
     connect_after(sigName: "focus-event", callback: Object.FocusEventSignalCallback): number
     emit(sigName: "focus-event", arg1: boolean, ...args: any[]): void
+    connect(sigName: "notification", callback: Object.NotificationSignalCallback): number
+    connect_after(sigName: "notification", callback: Object.NotificationSignalCallback): number
+    emit(sigName: "notification", arg1: string | null, arg2: number, ...args: any[]): void
     connect(sigName: "property-change", callback: Object.PropertyChangeSignalCallback): number
     connect_after(sigName: "property-change", callback: Object.PropertyChangeSignalCallback): number
     emit(sigName: "property-change", arg1: PropertyValues, ...args: any[]): void

package/atk-1.0.d.ts

@@ -95,6 +95,26 @@ enum Layer {
      */
     WINDOW,
 }
+/**
+ * Enumeration used to indicate a type of live region and how assertive it
+ * should be in terms of speaking notifications. Currently, this is only used
+ * for "notification" events, but it may be used for additional purposes
+ * in the future.
+ */
+enum Live {
+    /**
+     * No live region.
+     */
+    NONE,
+    /**
+     * This live region should be considered polite.
+     */
+    POLITE,
+    /**
+     * This live region should be considered assertive.
+     */
+    ASSERTIVE,
+}
 /**
  * Describes the type of the relation
  */
@@ -5902,6 +5922,13 @@ module Object {
         ($obj: Object, arg1: boolean): void
     }
 
+    /**
+     * Signal callback interface for `notification`
+     */
+    interface NotificationSignalCallback {
+        ($obj: Object, arg1: string | null, arg2: number): void
+    }
+
     /**
      * Signal callback interface for `property-change`
      */
@@ -6332,6 +6359,9 @@ interface Object {
     connect(sigName: "focus-event", callback: Object.FocusEventSignalCallback): number
     connect_after(sigName: "focus-event", callback: Object.FocusEventSignalCallback): number
     emit(sigName: "focus-event", arg1: boolean, ...args: any[]): void
+    connect(sigName: "notification", callback: Object.NotificationSignalCallback): number
+    connect_after(sigName: "notification", callback: Object.NotificationSignalCallback): number
+    emit(sigName: "notification", arg1: string | null, arg2: number, ...args: any[]): void
     connect(sigName: "property-change", callback: Object.PropertyChangeSignalCallback): number
     connect_after(sigName: "property-change", callback: Object.PropertyChangeSignalCallback): number
     emit(sigName: "property-change", arg1: PropertyValues, ...args: any[]): void

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@girs/atk-1.0",
-  "version": "2.48.3-3.2.3",
-  "description": "GJS TypeScript type definitions for Atk-1.0, generated from library version 2.48.3",
+  "version": "2.50.0-3.2.5",
+  "description": "GJS TypeScript type definitions for Atk-1.0, generated from library version 2.50.0",
   "type": "module",
   "module": "atk-1.0.js",
   "main": "atk-1.0.js",
@@ -25,9 +25,9 @@
     "test:cjs": "NODE_OPTIONS=--max_old_space_size=9216 tsc --noEmit atk-1.0.d.cts"
   },
   "dependencies": {
-    "@girs/gjs": "^3.2.3",
-    "@girs/glib-2.0": "^2.76.1-3.2.3",
-    "@girs/gobject-2.0": "^2.76.1-3.2.3"
+    "@girs/gjs": "^3.2.5",
+    "@girs/glib-2.0": "^2.78.0-3.2.5",
+    "@girs/gobject-2.0": "^2.78.0-3.2.5"
   },
   "devDependencies": {
     "typescript": "*"