@girs/gpaste-2 4.2.0 → 4.3.0

package/README.md

@@ -5,25 +5,25 @@
 ![downloads/week](https://img.shields.io/npm/dw/@girs/gpaste-2)
 
 
-GJS TypeScript type definitions for GPaste-2 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.2.0.
+GJS TypeScript type definitions for GPaste-2 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.3.0.
 
 ## Install
 
-To use this type definitions, install them with NPM:
+Install the type definitions with npm:
 ```bash
 npm install @girs/gpaste-2
 ```
 
 ## Usage
 
-You can import this package into your project like this:
+Import it like any other module:
 ```ts
 import GPaste from '@girs/gpaste-2';
 ```
 
 ### Ambient Modules
 
-You can also use [ambient modules](https://github.com/gjsify/ts-for-gir/tree/main/packages/cli#ambient-modules) to import this module like you would do this in JavaScript.
+[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/gpaste-2` or `@girs/gpaste-2/ambient` in your `tsconfig` or entry point Typescript file:
 
 `index.ts`:
@@ -42,7 +42,7 @@ import '@girs/gpaste-2'
 }
 ```
 
-Now you can import the ambient module with TypeScript support: 
+The ambient module now resolves with types:
 
 ```ts
 import GPaste from 'gi://GPaste?version=2';
@@ -50,7 +50,7 @@ import GPaste from 'gi://GPaste?version=2';
 
 ### Global import
 
-You can also import the module with Typescript support using the global `imports.gi` object of GJS.
+GJS's global `imports.gi` works too, with types.
 For this you need to include `@girs/gpaste-2` or `@girs/gpaste-2/import` in your `tsconfig` or entry point Typescript file:
 
 `index.ts`:
@@ -69,7 +69,7 @@ import '@girs/gpaste-2'
 }
 ```
 
-Now you have also type support for this, too:
+That form carries types as well:
 
 ```ts
 const GPaste = imports.gi.GPaste;
@@ -77,7 +77,7 @@ const GPaste = imports.gi.GPaste;
 
 ### 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).
+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.
 
 ## Other packages
 

package/gpaste-2.d.ts

@@ -171,6 +171,10 @@ export namespace GPaste {
 
     const HISTORY_NAME_SETTING: string;
 
+    const IMAGES_PREVIEW_SETTING: string;
+
+    const IMAGES_PREVIEW_SIZE_SETTING: string;
+
     const IMAGES_SUPPORT_SETTING: string;
 
     const LAUNCH_UI_SETTING: string;
@@ -1824,9 +1828,14 @@ export namespace GPaste {
         /**
          * Gets D-Bus introspection information for the D-Bus interface
          * implemented by `interface_`.
+         * 
+         * This can return `null` if no {@link Gio.DBusInterfaceInfo} was provided during
+         * construction of `interface_` and is also not made available otherwise.
+         * For example, {@link Gio.DBusProxy} implements {@link Gio.DBusInterface} but allows for a `null`
+         * {@link Gio.DBusInterfaceInfo}.
          * @returns A {@link Gio.DBusInterfaceInfo}. Do not free.
          */
-        get_info(): Gio.DBusInterfaceInfo;
+        get_info(): Gio.DBusInterfaceInfo | null;
 
         /**
          * Sets the {@link Gio.DBusObject} for `interface_` to `object`.
@@ -1845,9 +1854,14 @@ export namespace GPaste {
         /**
          * Gets D-Bus introspection information for the D-Bus interface
          * implemented by `interface_`.
+         * 
+         * This can return `null` if no {@link Gio.DBusInterfaceInfo} was provided during
+         * construction of `interface_` and is also not made available otherwise.
+         * For example, {@link Gio.DBusProxy} implements {@link Gio.DBusInterface} but allows for a `null`
+         * {@link Gio.DBusInterfaceInfo}.
          * @virtual
          */
-        vfunc_get_info(): Gio.DBusInterfaceInfo;
+        vfunc_get_info(): Gio.DBusInterfaceInfo | null;
 
         /**
          * Sets the {@link Gio.DBusObject} for `interface_` to `object`.
@@ -2026,13 +2040,13 @@ export namespace GPaste {
         }
 
         // Constructor properties interface
-        interface ConstructorProps extends Gio.DBusProxy.ConstructorProps, Gio.AsyncInitable.ConstructorProps, Gio.DBusInterface.ConstructorProps, Gio.Initable.ConstructorProps {}
+        interface ConstructorProps extends Gio.DBusProxy.ConstructorProps, KeybindingProvider.ConstructorProps, Gio.AsyncInitable.ConstructorProps, Gio.DBusInterface.ConstructorProps, Gio.Initable.ConstructorProps {}
     }
 
     /**
      * @gir-type Class
      */
-    class GnomeShellClient extends Gio.DBusProxy implements Gio.AsyncInitable<GnomeShellClient>, Gio.DBusInterface, Gio.Initable {
+    class GnomeShellClient extends Gio.DBusProxy implements KeybindingProvider, Gio.AsyncInitable<GnomeShellClient>, Gio.DBusInterface, Gio.Initable {
         static $gtype: GObject.GType<GnomeShellClient>;
 
         /**
@@ -2185,6 +2199,36 @@ export namespace GPaste {
          */
         ungrab_accelerator_sync(action: number): boolean;
 
+        /**
+         * Emit the "keybinding-activated" signal on `self`.
+         * @param id the id of the activated shortcut (its dconf key)
+         */
+        emit_keybinding_activated(id: string): void;
+
+        /**
+         * Replace all currently registered shortcuts with `accels`.
+         * @param accels a `null`-terminated (by id) array of {@link GPaste.KeybindingAccelerator}
+         */
+        grab_all(accels: KeybindingAccelerator[]): void;
+
+        /**
+         * Release all currently registered shortcuts.
+         */
+        ungrab_all(): void;
+
+        /**
+         * Replace all currently registered shortcuts with `accels`.
+         * @param accels a `null`-terminated (by id) array of {@link GPaste.KeybindingAccelerator}
+         * @virtual
+         */
+        vfunc_grab_all(accels: KeybindingAccelerator[]): void;
+
+        /**
+         * Release all currently registered shortcuts.
+         * @virtual
+         */
+        vfunc_ungrab_all(): void;
+
         /**
          * Starts asynchronous initialization of the object implementing the
          * interface. This must be done before any real use of the object after
@@ -2396,9 +2440,14 @@ export namespace GPaste {
         /**
          * Gets D-Bus introspection information for the D-Bus interface
          * implemented by `interface_`.
+         * 
+         * This can return `null` if no {@link Gio.DBusInterfaceInfo} was provided during
+         * construction of `interface_` and is also not made available otherwise.
+         * For example, {@link Gio.DBusProxy} implements {@link Gio.DBusInterface} but allows for a `null`
+         * {@link Gio.DBusInterfaceInfo}.
          * @returns A {@link Gio.DBusInterfaceInfo}. Do not free.
          */
-        get_info(): Gio.DBusInterfaceInfo;
+        get_info(): Gio.DBusInterfaceInfo | null;
 
         /**
          * Sets the {@link Gio.DBusObject} for `interface_` to `object`.
@@ -2417,9 +2466,14 @@ export namespace GPaste {
         /**
          * Gets D-Bus introspection information for the D-Bus interface
          * implemented by `interface_`.
+         * 
+         * This can return `null` if no {@link Gio.DBusInterfaceInfo} was provided during
+         * construction of `interface_` and is also not made available otherwise.
+         * For example, {@link Gio.DBusProxy} implements {@link Gio.DBusInterface} but allows for a `null`
+         * {@link Gio.DBusInterfaceInfo}.
          * @virtual
          */
-        vfunc_get_info(): Gio.DBusInterfaceInfo;
+        vfunc_get_info(): Gio.DBusInterfaceInfo | null;
 
         /**
          * Sets the {@link Gio.DBusObject} for `interface_` to `object`.
@@ -2808,9 +2862,14 @@ export namespace GPaste {
         /**
          * Gets D-Bus introspection information for the D-Bus interface
          * implemented by `interface_`.
+         * 
+         * This can return `null` if no {@link Gio.DBusInterfaceInfo} was provided during
+         * construction of `interface_` and is also not made available otherwise.
+         * For example, {@link Gio.DBusProxy} implements {@link Gio.DBusInterface} but allows for a `null`
+         * {@link Gio.DBusInterfaceInfo}.
          * @returns A {@link Gio.DBusInterfaceInfo}. Do not free.
          */
-        get_info(): Gio.DBusInterfaceInfo;
+        get_info(): Gio.DBusInterfaceInfo | null;
 
         /**
          * Sets the {@link Gio.DBusObject} for `interface_` to `object`.
@@ -2829,9 +2888,14 @@ export namespace GPaste {
         /**
          * Gets D-Bus introspection information for the D-Bus interface
          * implemented by `interface_`.
+         * 
+         * This can return `null` if no {@link Gio.DBusInterfaceInfo} was provided during
+         * construction of `interface_` and is also not made available otherwise.
+         * For example, {@link Gio.DBusProxy} implements {@link Gio.DBusInterface} but allows for a `null`
+         * {@link Gio.DBusInterfaceInfo}.
          * @virtual
          */
-        vfunc_get_info(): Gio.DBusInterfaceInfo;
+        vfunc_get_info(): Gio.DBusInterfaceInfo | null;
 
         /**
          * Sets the {@link Gio.DBusObject} for `interface_` to `object`.
@@ -3048,6 +3112,18 @@ export namespace GPaste {
          */
         get_history_name(): string;
 
+        /**
+         * Get the "images-preview" setting
+         * @returns the value of the "images-preview" setting
+         */
+        get_images_preview(): boolean;
+
+        /**
+         * Get the "images-preview-size" setting
+         * @returns the value of the "images-preview-size" setting
+         */
+        get_images_preview_size(): number;
+
         /**
          * Get the "images-support" setting
          * @returns the value of the "images-support" setting
@@ -3199,6 +3275,16 @@ export namespace GPaste {
          */
         reset_history_name(): void;
 
+        /**
+         * Reset the "images-preview" setting
+         */
+        reset_images_preview(): void;
+
+        /**
+         * Reset the "images-preview-size" setting
+         */
+        reset_images_preview_size(): void;
+
         /**
          * Reset the "images-support" setting
          */
@@ -3340,6 +3426,18 @@ export namespace GPaste {
          */
         set_history_name(value: string): void;
 
+        /**
+         * Change the "images-preview" setting
+         * @param value whether to enable or not image previews
+         */
+        set_images_preview(value: boolean): void;
+
+        /**
+         * Change the "images-preview-size" setting
+         * @param value the size of image previews in pixels
+         */
+        set_images_preview_size(value: bigint | number): void;
+
         /**
          * Change the "images-support" setting
          * @param value the new history name
@@ -3498,6 +3596,36 @@ export namespace GPaste {
      */
     type GnomeShellClientClass = typeof GnomeShellClient;
 
+    /**
+     * Represents a global shortcut to be registered with a {@link GPaste.KeybindingProvider}.
+     * Terminate an array of these with an entry whose `id` is `null`.
+     * @gir-type Struct
+     */
+    class KeybindingAccelerator {
+        static $gtype: GObject.GType<KeybindingAccelerator>;
+
+        // Fields
+        id: string;
+
+        accelerator: string;
+
+        description: string;
+
+        // Constructors
+
+        constructor(properties?: Partial<{
+            id: string;
+            accelerator: string;
+            description: string;
+        }>);
+    }
+
+
+    /**
+     * @gir-type Alias
+     */
+    type KeybindingProviderInterface = typeof KeybindingProvider;
+
     /**
      * @gir-type Alias
      */
@@ -3508,6 +3636,66 @@ export namespace GPaste {
      */
     type SettingsClass = typeof Settings;
 
+    namespace KeybindingProvider {
+        /**
+         * Interface for implementing KeybindingProvider.
+         * Contains only the virtual methods that need to be implemented.
+         */
+        interface Interface {
+
+            // Virtual methods
+            /**
+             * Replace all currently registered shortcuts with `accels`.
+             * @param accels a `null`-terminated (by id) array of {@link GPaste.KeybindingAccelerator}
+             * @virtual
+             */
+            vfunc_grab_all(accels: KeybindingAccelerator[]): void;
+
+            /**
+             * Release all currently registered shortcuts.
+             * @virtual
+             */
+            vfunc_ungrab_all(): void;
+        }
+
+
+        // Constructor properties interface
+        interface ConstructorProps extends GObject.Object.ConstructorProps {}
+    }
+
+    export interface KeybindingProviderNamespace {
+        $gtype: GObject.GType<KeybindingProvider>;
+        prototype: KeybindingProvider;
+    }
+    /**
+     * @gir-type Interface
+     */
+    interface KeybindingProvider extends GObject.Object, KeybindingProvider.Interface {
+
+        // Methods
+        /**
+         * Emit the "keybinding-activated" signal on `self`.
+         * @param id the id of the activated shortcut (its dconf key)
+         */
+        emit_keybinding_activated(id: string): void;
+
+        /**
+         * Replace all currently registered shortcuts with `accels`.
+         * @param accels a `null`-terminated (by id) array of {@link GPaste.KeybindingAccelerator}
+         */
+        grab_all(accels: KeybindingAccelerator[]): void;
+
+        /**
+         * Release all currently registered shortcuts.
+         */
+        ungrab_all(): void;
+    }
+
+
+    export const KeybindingProvider: KeybindingProviderNamespace & {
+        new (): KeybindingProvider; // This allows `obj instanceof KeybindingProvider`
+    };
+
     /**
      * Name of the imported GIR library
      * `see` https://gitlab.gnome.org/GNOME/gjs/-/blob/master/gi/ns.cpp#L188

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@girs/gpaste-2",
-    "version": "4.2.0",
+    "version": "4.3.0",
     "description": "GJS TypeScript type definitions for GPaste-2",
     "type": "module",
     "module": "gpaste-2.js",
@@ -31,11 +31,11 @@
       "test": "tsc --project tsconfig.json"
     },
     "dependencies": {
-      "@girs/gjs": "^4.2.0",
-      "@girs/gio-2.0": "^4.2.0",
-      "@girs/gobject-2.0": "^4.2.0",
-      "@girs/glib-2.0": "^4.2.0",
-      "@girs/gmodule-2.0": "^4.2.0"    },
+      "@girs/gjs": "^4.3.0",
+      "@girs/gio-2.0": "^4.3.0",
+      "@girs/gobject-2.0": "^4.3.0",
+      "@girs/glib-2.0": "^4.3.0",
+      "@girs/gmodule-2.0": "^4.3.0"    },
     "devDependencies": {
       "typescript": "*"
     },