@girs/bamf-3 4.3.0 → 4.5.0

package/README.md

@@ -4,82 +4,77 @@
 ![version](https://img.shields.io/npm/v/@girs/bamf-3)
 ![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.5.0.
 
-GJS TypeScript type definitions for Bamf-3 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/bamf-3
 ```
 
-## Usage
+Any package manager works. The package has no dependencies beyond other `@girs/*`
+type packages.
+
+## What it exports
+
+| Import | What you get |
+|---|---|
+| `@girs/bamf-3` | the namespace as a default export, plus the ambient and global declarations |
+| `@girs/bamf-3/ambient` | only the `gi://` module declarations |
+| `@girs/bamf-3/import` | only the `imports.gi` declarations |
+| `@girs/bamf-3/bamf-3` | 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 Bamf from '@girs/bamf-3';
 ```
 
-### 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/bamf-3` or `@girs/bamf-3/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/bamf-3'
+import '@girs/bamf-3';
 ```
 
-`tsconfig.json`:
 ```json
-{
-  "compilerOptions": {
-    ...
-  },
-  "include": ["@girs/bamf-3"],
-  ...
-}
+{ "include": ["@girs/bamf-3"] }
 ```
 
-The ambient module now resolves with types:
+Then the runtime spelling type-checks:
 
 ```ts
 import Bamf from 'gi://Bamf?version=3';
 ```
 
-### Global import
-
-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:
+Referencing `@girs/bamf-3/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/bamf-3'
-```
-
-`tsconfig.json`:
-```json
-{
-  "compilerOptions": {
-    ...
-  },
-  "include": ["@girs/bamf-3"],
-  ...
-}
-```
+### As `imports.gi`
 
-That form carries types as well:
+GJS's global object works the same way, via `@girs/bamf-3/import`:
 
 ```ts
 const Bamf = imports.gi.Bamf;
 ```
 
-### 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/bamf-3.d.ts

@@ -25,14 +25,14 @@ export namespace Bamf {
      * @gir-type Enum
      */
     enum ClickBehavior {
-        NONE,
-        OPEN,
-        FOCUS,
-        FOCUS_ALL,
-        MINIMIZE,
-        RESTORE,
-        RESTORE_ALL,
-        PICKER,
+        NONE = 0,
+        OPEN = 1,
+        FOCUS = 2,
+        FOCUS_ALL = 3,
+        MINIMIZE = 4,
+        RESTORE = 5,
+        RESTORE_ALL = 6,
+        PICKER = 7,
     }
 
 
@@ -40,10 +40,10 @@ export namespace Bamf {
      * @gir-type Enum
      */
     enum WindowMaximizationType {
-        FLOATING,
-        HORIZONTAL_MAXIMIZED,
-        VERTICAL_MAXIMIZED,
-        MAXIMIZED,
+        FLOATING = 0,
+        HORIZONTAL_MAXIMIZED = 1,
+        VERTICAL_MAXIMIZED = 2,
+        MAXIMIZED = 3,
     }
 
 
@@ -51,58 +51,121 @@ export namespace Bamf {
      * @gir-type Enum
      */
     enum WindowType {
-        NORMAL,
-        DESKTOP,
-        DOCK,
-        DIALOG,
-        TOOLBAR,
-        MENU,
-        UTILITY,
-        SPLASHSCREEN,
-        UNKNOWN,
+        NORMAL = 0,
+        DESKTOP = 1,
+        DOCK = 2,
+        DIALOG = 3,
+        TOOLBAR = 4,
+        MENU = 5,
+        UTILITY = 6,
+        SPLASHSCREEN = 7,
+        UNKNOWN = 8,
     }
 
 
+    /**
+     * @default desktop-file-updated
+     */
     const APPLICATION_SIGNAL_DESKTOP_FILE_UPDATED: string;
 
+    /**
+     * @default window-added
+     */
     const APPLICATION_SIGNAL_WINDOW_ADDED: string;
 
+    /**
+     * @default window-removed
+     */
     const APPLICATION_SIGNAL_WINDOW_REMOVED: string;
 
+    /**
+     * @default active-application-changed
+     */
     const MATCHER_SIGNAL_ACTIVE_APPLICATION_CHANGED: string;
 
+    /**
+     * @default active-window-changed
+     */
     const MATCHER_SIGNAL_ACTIVE_WINDOW_CHANGED: string;
 
+    /**
+     * @default stacking-order-changed
+     */
     const MATCHER_SIGNAL_STACKING_ORDER_CHANGED: string;
 
+    /**
+     * @default view-closed
+     */
     const MATCHER_SIGNAL_VIEW_CLOSED: string;
 
+    /**
+     * @default view-opened
+     */
     const MATCHER_SIGNAL_VIEW_OPENED: string;
 
+    /**
+     * @default active-changed
+     */
     const VIEW_SIGNAL_ACTIVE_CHANGED: string;
 
+    /**
+     * @default child-added
+     */
     const VIEW_SIGNAL_CHILD_ADDED: string;
 
+    /**
+     * @default child-moved
+     */
     const VIEW_SIGNAL_CHILD_MOVED: string;
 
+    /**
+     * @default child-removed
+     */
     const VIEW_SIGNAL_CHILD_REMOVED: string;
 
+    /**
+     * @default closed
+     */
     const VIEW_SIGNAL_CLOSED: string;
 
+    /**
+     * @default icon-changed
+     */
     const VIEW_SIGNAL_ICON_CHANGED: string;
 
+    /**
+     * @default name-changed
+     */
     const VIEW_SIGNAL_NAME_CHANGED: string;
 
+    /**
+     * @default running-changed
+     */
     const VIEW_SIGNAL_RUNNING_CHANGED: string;
 
+    /**
+     * @default starting-changed
+     */
     const VIEW_SIGNAL_STARTING_CHANGED: string;
 
+    /**
+     * @default urgent-changed
+     */
     const VIEW_SIGNAL_URGENT_CHANGED: string;
 
+    /**
+     * @default user-visible-changed
+     */
     const VIEW_SIGNAL_USER_VISIBLE_CHANGED: string;
 
+    /**
+     * @default maximized-changed
+     */
     const WINDOW_SIGNAL_MAXIMIZED_CHANGED: string;
 
+    /**
+     * @default monitor-changed
+     */
     const WINDOW_SIGNAL_MONITOR_CHANGED: string;
 
     /**
@@ -118,15 +181,15 @@ export namespace Bamf {
             /**
              * @signal
              */
-            "desktop-file-updated": (arg0: string) => void;
+            "desktop-file-updated": (object: string) => void;
             /**
              * @signal
              */
-            "window-added": (arg0: Window) => void;
+            "window-added": (object: Window) => void;
             /**
              * @signal
              */
-            "window-removed": (arg0: Window) => void;
+            "window-removed": (object: Window) => void;
             "notify::active": (pspec: GObject.ParamSpec) => void;
             "notify::path": (pspec: GObject.ParamSpec) => void;
             "notify::running": (pspec: GObject.ParamSpec) => void;
@@ -176,6 +239,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 +272,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;
 
@@ -299,11 +364,11 @@ export namespace Bamf {
             /**
              * @signal
              */
-            "active-application-changed": (arg0: Application, arg1: Application) => void;
+            "active-application-changed": (object: Application, p0: Application) => void;
             /**
              * @signal
              */
-            "active-window-changed": (arg0: Window, arg1: Window) => void;
+            "active-window-changed": (object: Window, p0: Window) => void;
             /**
              * @signal
              */
@@ -311,11 +376,11 @@ export namespace Bamf {
             /**
              * @signal
              */
-            "view-closed": (arg0: View) => void;
+            "view-closed": (object: View) => void;
             /**
              * @signal
              */
-            "view-opened": (arg0: View) => void;
+            "view-opened": (object: View) => void;
         }
 
         // Constructor properties interface
@@ -624,22 +689,22 @@ export namespace Bamf {
              * @signal
              * @run-first
              */
-            "active-changed": (arg0: boolean) => void;
+            "active-changed": (object: boolean) => void;
             /**
              * @signal
              * @run-first
              */
-            "child-added": (arg0: View) => void;
+            "child-added": (object: View) => void;
             /**
              * @signal
              * @run-first
              */
-            "child-moved": (arg0: View) => void;
+            "child-moved": (object: View) => void;
             /**
              * @signal
              * @run-first
              */
-            "child-removed": (arg0: View) => void;
+            "child-removed": (object: View) => void;
             /**
              * @signal
              * @run-last
@@ -648,31 +713,31 @@ export namespace Bamf {
             /**
              * @signal
              */
-            "icon-changed": (arg0: string) => void;
+            "icon-changed": (object: string) => void;
             /**
              * @signal
              */
-            "name-changed": (arg0: string, arg1: string) => void;
+            "name-changed": (object: string, p0: string) => void;
             /**
              * @signal
              * @run-first
              */
-            "running-changed": (arg0: boolean) => void;
+            "running-changed": (object: boolean) => void;
             /**
              * @signal
              * @run-first
              */
-            "starting-changed": (arg0: boolean) => void;
+            "starting-changed": (object: boolean) => void;
             /**
              * @signal
              * @run-first
              */
-            "urgent-changed": (arg0: boolean) => void;
+            "urgent-changed": (object: boolean) => void;
             /**
              * @signal
              * @run-first
              */
-            "user-visible-changed": (arg0: boolean) => void;
+            "user-visible-changed": (object: boolean) => void;
             "notify::active": (pspec: GObject.ParamSpec) => void;
             "notify::path": (pspec: GObject.ParamSpec) => void;
             "notify::running": (pspec: GObject.ParamSpec) => void;
@@ -853,6 +918,7 @@ export namespace Bamf {
         vfunc_is_urgent(): boolean;
 
         /**
+         * @since 0.4.0
          * @virtual
          */
         vfunc_is_user_visible(): boolean;
@@ -967,6 +1033,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 +1041,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[];
 
@@ -991,12 +1059,12 @@ export namespace Bamf {
              * @signal
              * @run-first
              */
-            "maximized-changed": (arg0: number, arg1: number) => void;
+            "maximized-changed": (object: number, p0: number) => void;
             /**
              * @signal
              * @run-first
              */
-            "monitor-changed": (arg0: number, arg1: number) => void;
+            "monitor-changed": (object: number, p0: number) => void;
             "notify::active": (pspec: GObject.ParamSpec) => void;
             "notify::path": (pspec: GObject.ParamSpec) => void;
             "notify::running": (pspec: GObject.ParamSpec) => void;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@girs/bamf-3",
-    "version": "4.3.0",
+    "version": "4.5.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.3.0",
-      "@girs/gobject-2.0": "^4.3.0",
-      "@girs/glib-2.0": "^4.3.0"    },
+      "@girs/gjs": "^4.5.0",
+      "@girs/gobject-2.0": "^4.5.0",
+      "@girs/glib-2.0": "^4.5.0"    },
     "devDependencies": {
       "typescript": "*"
     },