@vicinae/api 0.16.5 → 0.16.7

package/dist/api/window-management.js

@@ -13,6 +13,7 @@ const transformWorkspace = (proto) => {
 const transformWindow = (proto) => {
     return {
         id: proto.id,
+        title: proto.title,
         workspaceId: proto.workspaceId,
         active: proto.active,
         bounds: {
@@ -20,36 +21,61 @@ const transformWindow = (proto) => {
             size: { width: proto.width, height: proto.height },
         },
         application: proto.app,
+        focus() {
+            return WindowManagement.focusWindow(this);
+        },
     };
 };
 /**
  * Access Vicinae's window management features.
  *
  * @remarks
- * Window management features are available to a different degree depending on what environment vicinae runs
- * in.
+ * Window management support varies a lot depending on the environment.
+ * Right now it is pretty well supported on almost all linux desktop environments except KDE.
  *
  * @example
  * ```typescript
  * import { WindowManagement } from '@vicinae/api';
  *
- * const windows = await WindowManagement.getWindows();
+ * const wins = await WindowManagement.getWindows();
+ * const browserWindow = wins.find(w => w.application?.name?.includes('firefox'));
+ *
+ * if (browserWindow) {
+ *  await browserWindow.focus();
+ * }
  * ```
  *
+ * @category Window Management
  * @public
  */
 var WindowManagement;
 (function (WindowManagement) {
-    async function ping() {
-        const res = await bus_1.bus.turboRequest("wm.ping", {});
-        return res.unwrap().ok;
-    }
-    WindowManagement.ping = ping;
     async function getWindows(options = {}) {
         const res = await bus_1.bus.turboRequest("wm.getWindows", options);
         return res.unwrap().windows.map(transformWindow);
     }
     WindowManagement.getWindows = getWindows;
+    /**
+     * Focus `window`.
+     *
+     * @remarks
+     * Window objects have a {@link Window.focus} method that can be used to achieve the same thing on a specific window directly.
+     *
+     * @param window - the window to focus. You may want to make sure this window still exists when you request focus.
+     *
+     * @return `true` if the window was focused, `false` otherwise.
+     * A window may not have been focused because it doesn't accept focus (e.g some layer shell surfaces)
+     * or simply because it doesn't exist anymore.
+     *
+     * @see {@link Window.focus}
+     */
+    async function focusWindow(window) {
+        const res = await bus_1.bus.turboRequest("wm.focusWindow", {
+            id: window.id,
+        });
+        return res.unwrap().ok;
+    }
+    WindowManagement.focusWindow = focusWindow;
     /**
      * Return the list of screens (physical and virtual) currently attached to the computer.
      */

package/package.json

@@ -1,14 +1,13 @@
 {
 	"name": "@vicinae/api",
-	"version": "0.16.5",
+	"version": "0.16.7",
 	"description": "TypeScript SDK to build Vicinae extensions",
 	"scripts": {
 		"test": "echo \"Error: no test specified\" && exit 1",
 		"build": "tsc --outDir dist",
 		"protogen": "mkdir -p ./src/api/proto && protoc --plugin=./node_modules/.bin/protoc-gen-ts_proto -I../../proto ../../proto/*.proto --ts_proto_out ./src/api/proto",
 		"pack": "npm run build && npm pack",
-		"docgen-html": "typedoc src/api/index.ts",
-		"docgen-md": "typedoc src/api/index.ts --disableSources --readme none --plugin typedoc-plugin-markdown --out ./docs",
+		"docgen": "typedoc",
 		"format": "biome format --write"
 	},
 	"bin": {
@@ -58,6 +57,7 @@
 		"ts-node": "^10",
 		"ts-proto": "^2.7.5",
 		"typedoc": "^0.28.13",
+		"typedoc-github-theme": "^0.3.1",
 		"typedoc-plugin-markdown": "^4.8.1",
 		"typescript": "^5"
 	},

package/types/jsx.d.ts

@@ -107,7 +107,7 @@ declare module "react" {
 			};
 			"metadata-label": {
 				title: string;
-				text: string;
+				text: string | { color?: SerializedColorLike; value: string };
 				icon?: SerializedImageLike;
 			};
 			"metadata-separator": {};

package/dist/api/hooks/use-applications.d.ts

@@ -1,2 +0,0 @@
-import { Application } from "../utils";
-export declare const useApplications: () => [Application[], boolean, Error | null];

package/dist/api/hooks/use-applications.js

@@ -1,19 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useApplications = void 0;
-const react_1 = require("react");
-const utils_1 = require("../utils");
-const useApplications = () => {
-    const [isLoading, setIsLoading] = (0, react_1.useState)(true);
-    const [error, setError] = (0, react_1.useState)(null);
-    const [apps, setApps] = (0, react_1.useState)([]);
-    (0, react_1.useEffect)(() => {
-        setIsLoading(true);
-        (0, utils_1.getApplications)()
-            .then(setApps)
-            .catch(setError)
-            .finally(() => setIsLoading(false));
-    }, []);
-    return [apps, isLoading, error];
-};
-exports.useApplications = useApplications;