@girs/notify-0.7 0.8.2-3.2.3 → 0.8.2-3.2.8

package/README.md

@@ -5,7 +5,7 @@
 ![downloads/week](https://img.shields.io/npm/dw/@girs/notify-0.7)
 
 
-GJS TypeScript type definitions for Notify-0.7, generated from library version 0.8.2 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v3.2.3.
+GJS TypeScript type definitions for Notify-0.7, generated from library version 0.8.2 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v3.2.8.
 
 libnotify is a library that sends desktop notifications to a notification daemon, as defined in the Desktop Notifications spec. These notifications can be used to inform the user about an event or display some form of information without getting in the user's way.
 
@@ -82,6 +82,19 @@ Now you have also type support for this, too:
 const Notify = imports.gi.Notify;
 ```
 
+
+### 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/notify-0.7-ambient.d.ts

@@ -1,5 +1,4 @@
 
-
 declare module 'gi://Notify?version=0.7' {
     import Notify07 from '@girs/notify-0.7';
     export default Notify07;

package/notify-0.7-ambient.js

@@ -0,0 +1,2 @@
+export {}
+

package/notify-0.7-import.d.ts

@@ -1,5 +1,4 @@
 
-
 import Notify07 from '@girs/notify-0.7';
 
 declare global {

package/notify-0.7-import.js

@@ -0,0 +1,3 @@
+const gi = globalThis.imports?.gi || {};
+export default gi;
+

package/notify-0.7.d.cts

@@ -87,7 +87,7 @@ export const VERSION_MINOR: number
  * Gets the application name registered.
  * @returns The registered application name, passed to [func@init].
  */
-export function get_app_name(): string | null
+export function get_app_name(): string
 /**
  * Queries the server capabilities.
  * 
@@ -104,7 +104,7 @@ export function get_server_caps(): string[]
  * that it is compliant with.
  * @returns %TRUE if successful, and the variables passed will be set, %FALSE   on error. The returned strings must be freed with g_free
  */
-export function get_server_info(): [ /* returnType */ boolean, /* ret_name */ string | null, /* ret_vendor */ string | null, /* ret_version */ string | null, /* ret_spec_version */ string | null ]
+export function get_server_info(): [ /* returnType */ boolean, /* ret_name */ string, /* ret_vendor */ string, /* ret_version */ string, /* ret_spec_version */ string ]
 /**
  * Initialized libnotify. This must be called before any other functions.
  * 
@@ -124,7 +124,7 @@ export function is_initted(): boolean
  * Sets the application name.
  * @param app_name The name of the application
  */
-export function set_app_name(app_name: string | null): void
+export function set_app_name(app_name: string): void
 /**
  * Uninitializes libnotify.
  * 
@@ -162,7 +162,7 @@ export module Notification {
         /**
          * The name of the application for the notification.
          */
-        app_name?: string | null
+        appName?: string | null
         /**
          * The body of the notification.
          */
@@ -170,7 +170,7 @@ export module Notification {
         /**
          * The icon-name of the icon to be displayed on the notification.
          */
-        icon_name?: string | null
+        iconName?: string | null
         /**
          * The Id of the notification.
          */
@@ -190,7 +190,7 @@ export interface Notification {
     /**
      * The name of the application for the notification.
      */
-    app_name: string | null
+    appName: string | null
     /**
      * The body of the notification.
      */
@@ -200,11 +200,11 @@ export interface Notification {
      * 
      * See [signal`Notification:`:closed].
      */
-    readonly closed_reason: number
+    readonly closedReason: number
     /**
      * The icon-name of the icon to be displayed on the notification.
      */
-    icon_name: string | null
+    iconName: string | null
     /**
      * The Id of the notification.
      */
@@ -225,7 +225,7 @@ export interface Notification {
      * @param label The human-readable action label.
      * @param callback The action's callback function.
      */
-    add_action(action: string | null, label: string | null, callback: ActionCallback): void
+    add_action(action: string, label: string, callback: ActionCallback): void
     /**
      * Clears all actions from the notification.
      */
@@ -274,7 +274,7 @@ export interface Notification {
      * a certain way.
      * @param category The category.
      */
-    set_category(category: string | null): void
+    set_category(category: string): void
     /**
      * Sets a hint for `key` with value `value`.
      * 
@@ -284,13 +284,13 @@ export interface Notification {
      * @param key the hint key
      * @param value the hint value
      */
-    set_hint(key: string | null, value: GLib.Variant | null): void
+    set_hint(key: string, value: GLib.Variant | null): void
     /**
      * Sets a hint with a byte value.
      * @param key The hint.
      * @param value The hint's value.
      */
-    set_hint_byte(key: string | null, value: number): void
+    set_hint_byte(key: string, value: number): void
     /**
      * Sets a hint with a byte array value.
      * 
@@ -298,31 +298,31 @@ export interface Notification {
      * @param key The hint.
      * @param value The hint's value.
      */
-    set_hint_byte_array(key: string | null, value: Uint8Array): void
+    set_hint_byte_array(key: string, value: Uint8Array): void
     /**
      * Sets a hint with a double value.
      * @param key The hint.
      * @param value The hint's value.
      */
-    set_hint_double(key: string | null, value: number): void
+    set_hint_double(key: string, value: number): void
     /**
      * Sets a hint with a 32-bit integer value.
      * @param key The hint.
      * @param value The hint's value.
      */
-    set_hint_int32(key: string | null, value: number): void
+    set_hint_int32(key: string, value: number): void
     /**
      * Sets a hint with a string value.
      * @param key The hint.
      * @param value The hint's value.
      */
-    set_hint_string(key: string | null, value: string | null): void
+    set_hint_string(key: string, value: string): void
     /**
      * Sets a hint with an unsigned 32-bit integer value.
      * @param key The hint.
      * @param value The hint's value.
      */
-    set_hint_uint32(key: string | null, value: number): void
+    set_hint_uint32(key: string, value: number): void
     /**
      * Sets the icon in the notification from a #GdkPixbuf.
      * @param icon The icon.
@@ -363,7 +363,7 @@ export interface Notification {
      * @param icon The optional icon theme icon name or filename.
      * @returns %TRUE, unless an invalid parameter was passed.
      */
-    update(summary: string | null, body: string | null, icon: string | null): boolean
+    update(summary: string, body: string | null, icon: string | null): boolean
 
     // Own virtual methods of Notify-0.7.Notify.Notification
 
@@ -432,7 +432,7 @@ export class Notification extends GObject.Object {
      * @param icon The optional icon theme icon name or filename.
      * @returns The new #NotifyNotification.
      */
-    constructor(summary: string | null, body: string | null, icon: string | null) 
+    constructor(summary: string, body: string | null, icon: string | null) 
     /**
      * Creates a new #NotifyNotification.
      * 
@@ -443,7 +443,7 @@ export class Notification extends GObject.Object {
      * @param icon The optional icon theme icon name or filename.
      * @returns The new #NotifyNotification.
      */
-    static new(summary: string | null, body: string | null, icon: string | null): Notification
+    static new(summary: string, body: string | null, icon: string | null): Notification
     _init(config?: Notification.ConstructorProperties): void
 }
 

package/notify-0.7.d.ts

@@ -89,7 +89,7 @@ const VERSION_MINOR: number
  * Gets the application name registered.
  * @returns The registered application name, passed to [func@init].
  */
-function get_app_name(): string | null
+function get_app_name(): string
 /**
  * Queries the server capabilities.
  * 
@@ -106,7 +106,7 @@ function get_server_caps(): string[]
  * that it is compliant with.
  * @returns %TRUE if successful, and the variables passed will be set, %FALSE   on error. The returned strings must be freed with g_free
  */
-function get_server_info(): [ /* returnType */ boolean, /* ret_name */ string | null, /* ret_vendor */ string | null, /* ret_version */ string | null, /* ret_spec_version */ string | null ]
+function get_server_info(): [ /* returnType */ boolean, /* ret_name */ string, /* ret_vendor */ string, /* ret_version */ string, /* ret_spec_version */ string ]
 /**
  * Initialized libnotify. This must be called before any other functions.
  * 
@@ -126,7 +126,7 @@ function is_initted(): boolean
  * Sets the application name.
  * @param app_name The name of the application
  */
-function set_app_name(app_name: string | null): void
+function set_app_name(app_name: string): void
 /**
  * Uninitializes libnotify.
  * 
@@ -164,7 +164,7 @@ module Notification {
         /**
          * The name of the application for the notification.
          */
-        app_name?: string | null
+        appName?: string | null
         /**
          * The body of the notification.
          */
@@ -172,7 +172,7 @@ module Notification {
         /**
          * The icon-name of the icon to be displayed on the notification.
          */
-        icon_name?: string | null
+        iconName?: string | null
         /**
          * The Id of the notification.
          */
@@ -192,7 +192,7 @@ interface Notification {
     /**
      * The name of the application for the notification.
      */
-    app_name: string | null
+    appName: string | null
     /**
      * The body of the notification.
      */
@@ -202,11 +202,11 @@ interface Notification {
      * 
      * See [signal`Notification:`:closed].
      */
-    readonly closed_reason: number
+    readonly closedReason: number
     /**
      * The icon-name of the icon to be displayed on the notification.
      */
-    icon_name: string | null
+    iconName: string | null
     /**
      * The Id of the notification.
      */
@@ -227,7 +227,7 @@ interface Notification {
      * @param label The human-readable action label.
      * @param callback The action's callback function.
      */
-    add_action(action: string | null, label: string | null, callback: ActionCallback): void
+    add_action(action: string, label: string, callback: ActionCallback): void
     /**
      * Clears all actions from the notification.
      */
@@ -276,7 +276,7 @@ interface Notification {
      * a certain way.
      * @param category The category.
      */
-    set_category(category: string | null): void
+    set_category(category: string): void
     /**
      * Sets a hint for `key` with value `value`.
      * 
@@ -286,13 +286,13 @@ interface Notification {
      * @param key the hint key
      * @param value the hint value
      */
-    set_hint(key: string | null, value: GLib.Variant | null): void
+    set_hint(key: string, value: GLib.Variant | null): void
     /**
      * Sets a hint with a byte value.
      * @param key The hint.
      * @param value The hint's value.
      */
-    set_hint_byte(key: string | null, value: number): void
+    set_hint_byte(key: string, value: number): void
     /**
      * Sets a hint with a byte array value.
      * 
@@ -300,31 +300,31 @@ interface Notification {
      * @param key The hint.
      * @param value The hint's value.
      */
-    set_hint_byte_array(key: string | null, value: Uint8Array): void
+    set_hint_byte_array(key: string, value: Uint8Array): void
     /**
      * Sets a hint with a double value.
      * @param key The hint.
      * @param value The hint's value.
      */
-    set_hint_double(key: string | null, value: number): void
+    set_hint_double(key: string, value: number): void
     /**
      * Sets a hint with a 32-bit integer value.
      * @param key The hint.
      * @param value The hint's value.
      */
-    set_hint_int32(key: string | null, value: number): void
+    set_hint_int32(key: string, value: number): void
     /**
      * Sets a hint with a string value.
      * @param key The hint.
      * @param value The hint's value.
      */
-    set_hint_string(key: string | null, value: string | null): void
+    set_hint_string(key: string, value: string): void
     /**
      * Sets a hint with an unsigned 32-bit integer value.
      * @param key The hint.
      * @param value The hint's value.
      */
-    set_hint_uint32(key: string | null, value: number): void
+    set_hint_uint32(key: string, value: number): void
     /**
      * Sets the icon in the notification from a #GdkPixbuf.
      * @param icon The icon.
@@ -365,7 +365,7 @@ interface Notification {
      * @param icon The optional icon theme icon name or filename.
      * @returns %TRUE, unless an invalid parameter was passed.
      */
-    update(summary: string | null, body: string | null, icon: string | null): boolean
+    update(summary: string, body: string | null, icon: string | null): boolean
 
     // Own virtual methods of Notify-0.7.Notify.Notification
 
@@ -434,7 +434,7 @@ class Notification extends GObject.Object {
      * @param icon The optional icon theme icon name or filename.
      * @returns The new #NotifyNotification.
      */
-    constructor(summary: string | null, body: string | null, icon: string | null) 
+    constructor(summary: string, body: string | null, icon: string | null) 
     /**
      * Creates a new #NotifyNotification.
      * 
@@ -445,7 +445,7 @@ class Notification extends GObject.Object {
      * @param icon The optional icon theme icon name or filename.
      * @returns The new #NotifyNotification.
      */
-    static new(summary: string | null, body: string | null, icon: string | null): Notification
+    static new(summary: string, body: string | null, icon: string | null): Notification
     _init(config?: Notification.ConstructorProperties): void
 }
 

package/package.json

@@ -1,13 +1,19 @@
 {
   "name": "@girs/notify-0.7",
-  "version": "0.8.2-3.2.3",
+  "version": "0.8.2-3.2.8",
   "description": "GJS TypeScript type definitions for Notify-0.7, generated from library version 0.8.2",
   "type": "module",
   "module": "notify-0.7.js",
   "main": "notify-0.7.js",
   "exports": {
-    "./ambient": "./notify-0.7-ambient.d.ts",
-    "./import": "./notify-0.7-import.d.ts",
+    "./ambient": {
+      "types": "./notify-0.7-ambient.d.ts",
+      "default": "./notify-0.7-ambient.js"
+    },
+    "./import": {
+      "types": "./notify-0.7-import.d.ts",
+      "default": "./notify-0.7-import.js"
+    },
     ".": {
       "import": {
         "types": "./notify-0.7.d.ts",
@@ -25,12 +31,12 @@
     "test:cjs": "NODE_OPTIONS=--max_old_space_size=9216 tsc --noEmit notify-0.7.d.cts"
   },
   "dependencies": {
-    "@girs/gdkpixbuf-2.0": "^2.0.0-3.2.3",
-    "@girs/gio-2.0": "^2.76.1-3.2.3",
-    "@girs/gjs": "^3.2.3",
-    "@girs/glib-2.0": "^2.76.1-3.2.3",
-    "@girs/gmodule-2.0": "^2.0.0-3.2.3",
-    "@girs/gobject-2.0": "^2.76.1-3.2.3"
+    "@girs/gdkpixbuf-2.0": "^2.0.0-3.2.8",
+    "@girs/gio-2.0": "^2.77.0-3.2.8",
+    "@girs/gjs": "^3.2.8",
+    "@girs/glib-2.0": "^2.77.0-3.2.8",
+    "@girs/gmodule-2.0": "^2.0.0-3.2.8",
+    "@girs/gobject-2.0": "^2.77.0-3.2.8"
   },
   "devDependencies": {
     "typescript": "*"
@@ -47,7 +53,7 @@
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/gjsify/types.git"
+    "url": "git+https://github.com/gjsify/ts-for-gir.git"
   },
   "bugs": {
     "url": "https://github.com/gjsify/ts-for-gir/issues"