@girs/bamf-3 4.2.0 → 4.4.0

package/README.md

@@ -5,25 +5,25 @@
 ![downloads/week](https://img.shields.io/npm/dw/@girs/bamf-3)
 
 
-GJS TypeScript type definitions for Bamf-3 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.2.0.
+GJS TypeScript type definitions for Bamf-3 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.4.0.
 
 ## Install
 
-To use this type definitions, install them with NPM:
+Install the type definitions with npm:
 ```bash
 npm install @girs/bamf-3
 ```
 
 ## Usage
 
-You can import this package into your project like this:
+Import it like any other module:
 ```ts
 import Bamf from '@girs/bamf-3';
 ```
 
 ### 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/bamf-3` or `@girs/bamf-3/ambient` in your `tsconfig` or entry point Typescript file:
 
 `index.ts`:
@@ -42,7 +42,7 @@ import '@girs/bamf-3'
 }
 ```
 
-Now you can import the ambient module with TypeScript support: 
+The ambient module now resolves with types:
 
 ```ts
 import Bamf from 'gi://Bamf?version=3';
@@ -50,7 +50,7 @@ import Bamf from 'gi://Bamf?version=3';
 
 ### 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/bamf-3` or `@girs/bamf-3/import` in your `tsconfig` or entry point Typescript file:
 
 `index.ts`:
@@ -69,7 +69,7 @@ import '@girs/bamf-3'
 }
 ```
 
-Now you have also type support for this, too:
+That form carries types as well:
 
 ```ts
 const Bamf = imports.gi.Bamf;
@@ -77,7 +77,7 @@ const Bamf = imports.gi.Bamf;
 
 ### 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/bamf-3.d.ts

@@ -176,6 +176,7 @@ export namespace Bamf {
         /**
          * Used to fetch the bus name and the object path of the remote application menu.
          * @returns `true` if found, `false` otherwise.
+         * @deprecated since 0.5.0
          */
         get_application_menu(): [boolean, string, string];
 
@@ -208,6 +209,7 @@ export namespace Bamf {
          * Used to fetch the application contains a Window with given `xid`.
          * @param xid an X11 Window ID
          * @returns a {@link Bamf.Window} for the passed `xid` or `null` if not found.
+         * @since 0.5.2
          */
         get_window_for_xid(xid: number): Window;
 
@@ -853,6 +855,7 @@ export namespace Bamf {
         vfunc_is_urgent(): boolean;
 
         /**
+         * @since 0.4.0
          * @virtual
          */
         vfunc_is_user_visible(): boolean;
@@ -967,6 +970,7 @@ export namespace Bamf {
 
         /**
          * @returns a boolean useful for determining if a particular view is "user visible". User visible is a concept relating to whether or not a window should be shown in a launcher tasklist.
+         * @since 0.4.0
          */
         is_user_visible(): boolean;
 
@@ -974,6 +978,7 @@ export namespace Bamf {
          * Note: Makes sever dbus calls the first time this is called on a view.
          * Dbus messaging is reduced afterwards.
          * @returns Returns a list of {@link Bamf.View} which           is owned by the {@link Bamf.View} and should not freed or modified after usage.
+         * @since 0.5.2
          */
         peek_children(): View[];
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@girs/bamf-3",
-    "version": "4.2.0",
+    "version": "4.4.0",
     "description": "GJS TypeScript type definitions for Bamf-3",
     "type": "module",
     "module": "bamf-3.js",
@@ -31,9 +31,9 @@
       "test": "tsc --project tsconfig.json"
     },
     "dependencies": {
-      "@girs/gjs": "^4.2.0",
-      "@girs/gobject-2.0": "^4.2.0",
-      "@girs/glib-2.0": "^4.2.0"    },
+      "@girs/gjs": "^4.4.0",
+      "@girs/gobject-2.0": "^4.4.0",
+      "@girs/glib-2.0": "^4.4.0"    },
     "devDependencies": {
       "typescript": "*"
     },