@girs/cinnamondesktop-3.0 4.3.0 → 4.5.0

package/README.md

@@ -4,82 +4,77 @@
 ![version](https://img.shields.io/npm/v/@girs/cinnamondesktop-3.0)
 ![downloads/week](https://img.shields.io/npm/dw/@girs/cinnamondesktop-3.0)
 
+GJS TypeScript type definitions for CinnamonDesktop-3.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.5.0.
 
-GJS TypeScript type definitions for CinnamonDesktop-3.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.3.0.
+This package contains type declarations only. It ships no runtime code, so it adds
+nothing to your program and works with any bundler or none at all.
 
 ## Install
 
-Install the type definitions with npm:
 ```bash
 npm install @girs/cinnamondesktop-3.0
 ```
 
-## Usage
+Any package manager works. The package has no dependencies beyond other `@girs/*`
+type packages.
+
+## What it exports
+
+| Import | What you get |
+|---|---|
+| `@girs/cinnamondesktop-3.0` | the namespace as a default export, plus the ambient and global declarations |
+| `@girs/cinnamondesktop-3.0/ambient` | only the `gi://` module declarations |
+| `@girs/cinnamondesktop-3.0/import` | only the `imports.gi` declarations |
+| `@girs/cinnamondesktop-3.0/cinnamondesktop-3.0` | the namespace, without the side-effecting declarations |
+
+## Three ways to import
+
+Which one you use depends on how you write imports elsewhere, not on your toolchain.
+
+### As a module
 
-Import it like any other module:
 ```ts
 import CinnamonDesktop from '@girs/cinnamondesktop-3.0';
 ```
 
-### Ambient Modules
+### As `gi://`
 
-[Ambient modules](https://github.com/gjsify/ts-for-gir/tree/main/packages/cli#ambient-modules) let you write the same import you would in plain JavaScript.
-For this you need to include `@girs/cinnamondesktop-3.0` or `@girs/cinnamondesktop-3.0/ambient` in your `tsconfig` or entry point Typescript file:
+GJS resolves `gi://` at runtime. To give it types, reference the package once, either
+from your entry point or from `tsconfig.json`:
 
-`index.ts`:
 ```ts
-import '@girs/cinnamondesktop-3.0'
+import '@girs/cinnamondesktop-3.0';
 ```
 
-`tsconfig.json`:
 ```json
-{
-  "compilerOptions": {
-    ...
-  },
-  "include": ["@girs/cinnamondesktop-3.0"],
-  ...
-}
+{ "include": ["@girs/cinnamondesktop-3.0"] }
 ```
 
-The ambient module now resolves with types:
+Then the runtime spelling type-checks:
 
 ```ts
 import CinnamonDesktop from 'gi://CinnamonDesktop?version=3.0';
 ```
 
-### Global import
-
-GJS's global `imports.gi` works too, with types.
-For this you need to include `@girs/cinnamondesktop-3.0` or `@girs/cinnamondesktop-3.0/import` in your `tsconfig` or entry point Typescript file:
+Referencing `@girs/cinnamondesktop-3.0/ambient` instead pulls in these declarations
+alone. See [ambient modules](https://github.com/gjsify/ts-for-gir/tree/main/packages/cli#ambient-modules).
 
-`index.ts`:
-```ts
-import '@girs/cinnamondesktop-3.0'
-```
-
-`tsconfig.json`:
-```json
-{
-  "compilerOptions": {
-    ...
-  },
-  "include": ["@girs/cinnamondesktop-3.0"],
-  ...
-}
-```
+### As `imports.gi`
 
-That form carries types as well:
+GJS's global object works the same way, via `@girs/cinnamondesktop-3.0/import`:
 
 ```ts
 const CinnamonDesktop = imports.gi.CinnamonDesktop;
 ```
 
-### Bundle
+## Building
 
-Most projects want a bundler. [esbuild](https://esbuild.github.io/) is the smallest thing that works; the [examples directory](https://github.com/gjsify/ts-for-gir/tree/main/examples) has setups for several others.
+The declarations need no build step. If you bundle, every bundler works, since there is
+no runtime code to resolve. The [examples](https://github.com/gjsify/ts-for-gir/tree/main/examples)
+show working setups for several.
 
 ## Other packages
 
-All existing pre-generated packages can be found on [gjsify/types](https://github.com/gjsify/types).
+Every pre-generated package is at [gjsify/types](https://github.com/gjsify/types).
+
 

package/cinnamondesktop-3.0.d.ts

@@ -37,8 +37,8 @@ export namespace CinnamonDesktop {
      * @gir-type Enum
      */
     enum DesktopThumbnailSize {
-        NORMAL,
-        LARGE,
+        NORMAL = 0,
+        LARGE = 1,
     }
 
 
@@ -46,11 +46,11 @@ export namespace CinnamonDesktop {
      * @gir-type Enum
      */
     enum RRDpmsMode {
-        ON,
-        STANDBY,
-        SUSPEND,
-        OFF,
-        UNKNOWN,
+        ON = 0,
+        STANDBY = 1,
+        SUSPEND = 2,
+        OFF = 3,
+        UNKNOWN = 4,
     }
 
 
@@ -65,11 +65,11 @@ export namespace CinnamonDesktop {
      * @gir-type Enum
      */
     enum RRDpmsModeType {
-        ON,
-        STANDBY,
-        SUSPEND,
-        OFF,
-        UNKNOWN,
+        ON = 0,
+        STANDBY = 1,
+        SUSPEND = 2,
+        OFF = 3,
+        UNKNOWN = 4,
     }
 
 
@@ -99,6 +99,9 @@ export namespace CinnamonDesktop {
     }
 
 
+    /**
+     * @default Panel
+     */
     const RR_CONNECTOR_TYPE_PANEL: string;
 
     /**
@@ -372,6 +375,7 @@ export namespace CinnamonDesktop {
      * created. It solely means that no error condition was hit sending the request.
      * @param res A {@link Gio.AsyncResult}
      * @returns `false` on error, `true` otherwise
+     * @throws GLib.Error
      */
     function start_systemd_scope_finish(res: Gio.AsyncResult): boolean;
 
@@ -386,13 +390,13 @@ export namespace CinnamonDesktop {
      * @gir-type Flags
      */
     enum RRRotation {
-        ROTATION_NEXT,
-        ROTATION_0,
-        ROTATION_90,
-        ROTATION_180,
-        ROTATION_270,
-        REFLECT_X,
-        REFLECT_Y,
+        ROTATION_NEXT = 0,
+        ROTATION_0 = 1,
+        ROTATION_90 = 2,
+        ROTATION_180 = 4,
+        ROTATION_270 = 8,
+        REFLECT_X = 16,
+        REFLECT_Y = 32,
     }
 
 
@@ -613,7 +617,7 @@ export namespace CinnamonDesktop {
              * @signal
              * @run-last
              */
-            finished: (arg0: GObject.Object) => void;
+            finished: (window: GObject.Object) => void;
             "notify::height": (pspec: GObject.ParamSpec) => void;
             "notify::width": (pspec: GObject.ParamSpec) => void;
         }
@@ -786,6 +790,7 @@ export namespace CinnamonDesktop {
          * @param mime_type the mime type of the file
          * @param mtime the mtime of the file
          * @returns TRUE if the file can be thumbnailed.
+         * @since 2.2
          */
         can_thumbnail(uri: string, mime_type: string, mtime: bigint | number): boolean;
 
@@ -796,6 +801,7 @@ export namespace CinnamonDesktop {
          * Usage of this function is threadsafe.
          * @param uri the uri of a file
          * @param mtime the modification time of the file
+         * @since 2.2
          */
         create_failed_thumbnail(uri: string, mtime: bigint | number): void;
 
@@ -807,6 +813,7 @@ export namespace CinnamonDesktop {
          * @param uri the uri of a file
          * @param mime_type the mime type of the file
          * @returns thumbnail pixbuf if thumbnailing succeeded, `null` otherwise.
+         * @since 2.2
          */
         generate_thumbnail(uri: string, mime_type: string): GdkPixbuf.Pixbuf;
 
@@ -819,6 +826,7 @@ export namespace CinnamonDesktop {
          * @param uri the uri of a file
          * @param mtime the mtime of the file
          * @returns TRUE if there is a failed thumbnail for the file.
+         * @since 2.2
          */
         has_valid_failed_thumbnail(uri: string, mtime: bigint | number): boolean;
 
@@ -829,6 +837,7 @@ export namespace CinnamonDesktop {
          * @param uri the uri of a file
          * @param mtime the mtime of the file
          * @returns The absolute path of the thumbnail, or `null` if none exist.
+         * @since 2.2
          */
         lookup(uri: string, mtime: bigint | number): string;
 
@@ -840,6 +849,7 @@ export namespace CinnamonDesktop {
          * @param thumbnail the thumbnail as a pixbuf
          * @param uri the uri of a file
          * @param original_mtime the modification time of the original file
+         * @since 2.2
          */
         save_thumbnail(thumbnail: GdkPixbuf.Pixbuf, uri: string, original_mtime: bigint | number): void;
     }
@@ -956,6 +966,8 @@ export namespace CinnamonDesktop {
          * instance.
          * @param cancellable optional {@link Gio.Cancellable} object, `null` to ignore.
          * @returns `true` if successful. If an error has occurred, this function will     return `false` and set `error` appropriately if present.
+         * @since 2.22
+         * @throws GLib.Error
          */
         init(cancellable: Gio.Cancellable | null): boolean;
 
@@ -999,6 +1011,7 @@ export namespace CinnamonDesktop {
          * on the result of `g_object_new()`, regardless of whether it is in fact a new
          * instance.
          * @param cancellable optional {@link Gio.Cancellable} object, `null` to ignore.
+         * @since 2.22
          * @virtual
          */
         vfunc_init(cancellable: Gio.Cancellable | null): boolean;
@@ -1114,16 +1127,19 @@ export namespace CinnamonDesktop {
         // Methods
         /**
          * @param screen 
+         * @throws GLib.Error
          */
         applicable(screen: RRScreen): boolean;
 
         /**
          * @param screen 
+         * @throws GLib.Error
          */
         apply(screen: RRScreen): boolean;
 
         /**
          * @param screen 
+         * @throws GLib.Error
          */
         apply_persistent(screen: RRScreen): boolean;
 
@@ -1144,6 +1160,9 @@ export namespace CinnamonDesktop {
          */
         get_outputs(): RROutputInfo[];
 
+        /**
+         * @throws GLib.Error
+         */
         load_current(): boolean;
 
         /**
@@ -1392,7 +1411,7 @@ export namespace CinnamonDesktop {
              * @signal
              * @run-first
              */
-            "output-connected": (arg0: null) => void;
+            "output-connected": (output: null) => void;
             /**
              * This signal is emitted when a display device is disconnected from
              * a port, or a port output is hot-unplugged. The latter can happen
@@ -1409,7 +1428,7 @@ export namespace CinnamonDesktop {
              * @signal
              * @run-first
              */
-            "output-disconnected": (arg0: null) => void;
+            "output-disconnected": (output: null) => void;
             "notify::dpms-mode": (pspec: GObject.ParamSpec) => void;
             "notify::gdk-screen": (pspec: GObject.ParamSpec) => void;
         }
@@ -1518,6 +1537,9 @@ export namespace CinnamonDesktop {
          */
         get_crtc_by_id(id: number): RRCrtc;
 
+        /**
+         * @throws GLib.Error
+         */
         get_dpms_mode(): [boolean, RRDpmsMode];
 
         /**
@@ -1561,12 +1583,14 @@ export namespace CinnamonDesktop {
          * Refreshes the screen configuration, and calls the screen's callback if it
          * exists and if the screen's configuration changed.
          * @returns TRUE if the screen's configuration changed; otherwise, the function returns FALSE and a NULL error if the configuration didn't change, or FALSE and a non-NULL error if there was an error while refreshing the configuration.
+         * @throws GLib.Error
          */
         refresh(): boolean;
 
         /**
          * This method also disables the DPMS timeouts.
          * @param mode 
+         * @throws GLib.Error
          */
         set_dpms_mode(mode: RRDpmsMode): boolean;
 
@@ -1609,6 +1633,7 @@ export namespace CinnamonDesktop {
          * any interface methods.
          * @param io_priority the [I/O priority](iface.AsyncResult.html#io-priority) of the operation
          * @param cancellable optional {@link Gio.Cancellable} object, `null` to ignore.
+         * @since 2.22
          */
         init_async(io_priority: number, cancellable: Gio.Cancellable | null): globalThis.Promise<boolean>;
 
@@ -1652,6 +1677,7 @@ export namespace CinnamonDesktop {
          * @param io_priority the [I/O priority](iface.AsyncResult.html#io-priority) of the operation
          * @param cancellable optional {@link Gio.Cancellable} object, `null` to ignore.
          * @param callback a {@link Gio.AsyncReadyCallback} to call when the request is satisfied
+         * @since 2.22
          */
         init_async(io_priority: number, cancellable: Gio.Cancellable | null, callback: Gio.AsyncReadyCallback<this> | null): void;
 
@@ -1695,6 +1721,7 @@ export namespace CinnamonDesktop {
          * @param io_priority the [I/O priority](iface.AsyncResult.html#io-priority) of the operation
          * @param cancellable optional {@link Gio.Cancellable} object, `null` to ignore.
          * @param callback a {@link Gio.AsyncReadyCallback} to call when the request is satisfied
+         * @since 2.22
          */
         init_async(io_priority: number, cancellable: Gio.Cancellable | null, callback?: Gio.AsyncReadyCallback<this> | null): globalThis.Promise<boolean> | void;
 
@@ -1703,6 +1730,8 @@ export namespace CinnamonDesktop {
          * See `g_async_initable_init_async()`.
          * @param res a {@link Gio.AsyncResult}.
          * @returns `true` if successful. If an error has occurred, this function will return `false` and set `error` appropriately if present.
+         * @since 2.22
+         * @throws GLib.Error
          */
         init_finish(res: Gio.AsyncResult): boolean;
 
@@ -1711,6 +1740,8 @@ export namespace CinnamonDesktop {
          * calls, returning the created object or `null` on error.
          * @param res the {@link Gio.AsyncResult} from the callback
          * @returns a newly created {@link GObject.Object},      or `null` on error. Free with `g_object_unref()`.
+         * @since 2.22
+         * @throws GLib.Error
          */
         new_finish(res: Gio.AsyncResult): RRScreen;
 
@@ -1754,6 +1785,7 @@ export namespace CinnamonDesktop {
          * @param io_priority the [I/O priority](iface.AsyncResult.html#io-priority) of the operation
          * @param cancellable optional {@link Gio.Cancellable} object, `null` to ignore.
          * @param callback a {@link Gio.AsyncReadyCallback} to call when the request is satisfied
+         * @since 2.22
          * @virtual
          */
         vfunc_init_async(io_priority: number, cancellable: Gio.Cancellable | null, callback: Gio.AsyncReadyCallback<this> | null): void;
@@ -1762,6 +1794,7 @@ export namespace CinnamonDesktop {
          * Finishes asynchronous initialization and returns the result.
          * See `g_async_initable_init_async()`.
          * @param res a {@link Gio.AsyncResult}.
+         * @since 2.22
          * @virtual
          */
         vfunc_init_finish(res: Gio.AsyncResult): boolean;
@@ -1807,6 +1840,8 @@ export namespace CinnamonDesktop {
          * instance.
          * @param cancellable optional {@link Gio.Cancellable} object, `null` to ignore.
          * @returns `true` if successful. If an error has occurred, this function will     return `false` and set `error` appropriately if present.
+         * @since 2.22
+         * @throws GLib.Error
          */
         init(cancellable: Gio.Cancellable | null): boolean;
 
@@ -1850,6 +1885,7 @@ export namespace CinnamonDesktop {
          * on the result of `g_object_new()`, regardless of whether it is in fact a new
          * instance.
          * @param cancellable optional {@link Gio.Cancellable} object, `null` to ignore.
+         * @since 2.22
          * @virtual
          */
         vfunc_init(cancellable: Gio.Cancellable | null): boolean;
@@ -2042,6 +2078,7 @@ export namespace CinnamonDesktop {
         /**
          * @param group_id identifier for group
          * @returns the translated description for the group `group_id`.
+         * @since 3.8
          */
         description_for_group(group_id: string): string;
 
@@ -2049,18 +2086,21 @@ export namespace CinnamonDesktop {
          * @param group_id identifier for group containing the option
          * @param id option identifier
          * @returns the translated description for the option `id`.
+         * @since 3.6
          */
         description_for_option(group_id: string, id: string): string;
 
         /**
          * Returns a list of all layout identifiers we know about.
          * @returns the list of layout names. The caller takes ownership of the {@link GLib.List} but not of the strings themselves, those are internally allocated and must not be modified.
+         * @since 3.6
          */
         get_all_layouts(): string[];
 
         /**
          * Returns a list of all option group identifiers we know about.
          * @returns the list of option group ids. The caller takes ownership of the {@link GLib.List} but not of the strings themselves, those are internally allocated and must not be modified.
+         * @since 3.6
          */
         get_all_option_groups(): string[];
 
@@ -2069,6 +2109,7 @@ export namespace CinnamonDesktop {
          * `layout_id`.
          * @param layout_id a layout identifier
          * @returns the list of ISO 639 code strings. The caller takes ownership of the {@link GLib.List} but not of the strings themselves, those are internally allocated and must not be modified.
+         * @since 3.18
          */
         get_languages_for_layout(layout_id: string): string[];
 
@@ -2085,6 +2126,7 @@ export namespace CinnamonDesktop {
          * all the (out) parameters are set to `null`.
          * @param id layout's identifier about which to retrieve the info
          * @returns `true` if the layout exists or `false` otherwise.
+         * @since 3.6
          */
         get_layout_info(id: string): [boolean, string, string, string, string];
 
@@ -2093,6 +2135,7 @@ export namespace CinnamonDesktop {
          * `country_code`.
          * @param country_code an ISO 3166 code string
          * @returns the list of layout ids. The caller takes ownership of the {@link GLib.List} but not of the strings themselves, those are internally allocated and must not be modified.
+         * @since 3.8
          */
         get_layouts_for_country(country_code: string): string[];
 
@@ -2101,6 +2144,7 @@ export namespace CinnamonDesktop {
          * `language_code`.
          * @param language_code an ISO 639 code string
          * @returns the list of layout ids. The caller takes ownership of the {@link GLib.List} but not of the strings themselves, those are internally allocated and must not be modified.
+         * @since 3.8
          */
         get_layouts_for_language(language_code: string): string[];
 
@@ -2116,6 +2160,7 @@ export namespace CinnamonDesktop {
          * `group_id`.
          * @param group_id group's identifier about which to retrieve the options
          * @returns the list of option ids. The caller takes ownership of the {@link GLib.List} but not of the strings themselves, those are internally allocated and must not be modified.
+         * @since 6.6
          */
         get_options_for_group(group_id: string): string[];
     }
@@ -2343,6 +2388,7 @@ export namespace CinnamonDesktop {
         /**
          * @param value the absolute value which is 0 >= this <= 100
          * @returns `true` for success
+         * @throws GLib.Error
          */
         set_backlight(value: number): boolean;
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@girs/cinnamondesktop-3.0",
-    "version": "4.3.0",
+    "version": "4.5.0",
     "description": "GJS TypeScript type definitions for CinnamonDesktop-3.0",
     "type": "module",
     "module": "cinnamondesktop-3.0.js",
@@ -31,21 +31,21 @@
       "test": "tsc --project tsconfig.json"
     },
     "dependencies": {
-      "@girs/gjs": "^4.3.0",
-      "@girs/gtk-3.0": "^4.3.0",
-      "@girs/xlib-2.0": "^4.3.0",
-      "@girs/gdk-3.0": "^4.3.0",
-      "@girs/cairo-1.0": "^4.3.0",
-      "@girs/gobject-2.0": "^4.3.0",
-      "@girs/glib-2.0": "^4.3.0",
-      "@girs/pango-1.0": "^4.3.0",
-      "@girs/harfbuzz-0.0": "^4.3.0",
-      "@girs/freetype2-2.0": "^4.3.0",
-      "@girs/gio-2.0": "^4.3.0",
-      "@girs/gmodule-2.0": "^4.3.0",
-      "@girs/gdkpixbuf-2.0": "^4.3.0",
-      "@girs/atk-1.0": "^4.3.0",
-      "@girs/cdesktopenums-3.0": "^4.3.0"    },
+      "@girs/gjs": "^4.5.0",
+      "@girs/gtk-3.0": "^4.5.0",
+      "@girs/xlib-2.0": "^4.5.0",
+      "@girs/gdk-3.0": "^4.5.0",
+      "@girs/cairo-1.0": "^4.5.0",
+      "@girs/gobject-2.0": "^4.5.0",
+      "@girs/glib-2.0": "^4.5.0",
+      "@girs/pango-1.0": "^4.5.0",
+      "@girs/harfbuzz-0.0": "^4.5.0",
+      "@girs/freetype2-2.0": "^4.5.0",
+      "@girs/gio-2.0": "^4.5.0",
+      "@girs/gmodule-2.0": "^4.5.0",
+      "@girs/gdkpixbuf-2.0": "^4.5.0",
+      "@girs/atk-1.0": "^4.5.0",
+      "@girs/cdesktopenums-3.0": "^4.5.0"    },
     "devDependencies": {
       "typescript": "*"
     },