@vicinae/api 0.16.5 → 0.16.7

package/dist/api/proto/wm.js

@@ -5,42 +5,56 @@
 //   protoc               v6.32.1
 // source: wm.proto
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Response = exports.Request = exports.SetWindowBoundsResponse = exports.SetWindowBoundsRequest = exports.GetWindowsResponse = exports.GetWindowsRequest = exports.GetScreensResponse = exports.GetScreensRequest = exports.GetActiveWorkspaceWindowsResponse = exports.GetActiveWorkspaceWindowsRequest = exports.GetActiveWorkspaceResponse = exports.GetActiveWorkspaceRequest = exports.GetWorkspacesResponse = exports.GetWorkspacesRequest = exports.GetActiveWindowResponse = exports.GetActiveWindowRequest = exports.PingResponse = exports.PingRequest = exports.Workspace = exports.Screen = exports.Window = exports.protobufPackage = void 0;
+exports.Response = exports.Request = exports.SetWindowBoundsResponse = exports.SetWindowBoundsRequest = exports.GetWindowsResponse = exports.GetWindowsRequest = exports.GetScreensResponse = exports.GetScreensRequest = exports.GetActiveWorkspaceWindowsResponse = exports.GetActiveWorkspaceWindowsRequest = exports.GetActiveWorkspaceResponse = exports.GetActiveWorkspaceRequest = exports.GetWorkspacesResponse = exports.GetWorkspacesRequest = exports.GetActiveWindowResponse = exports.GetActiveWindowRequest = exports.FocusWindowResponse = exports.FocusWindowRequest = exports.PingResponse = exports.PingRequest = exports.Workspace = exports.Screen = exports.Window = exports.protobufPackage = void 0;
 /* eslint-disable */
 const wire_1 = require("@bufbuild/protobuf/wire");
 const application_1 = require("./application");
 exports.protobufPackage = "proto.ext.wm";
 function createBaseWindow() {
-    return { id: "", workspaceId: "", active: false, fullscreen: false, x: 0, y: 0, width: 0, height: 0, app: undefined };
+    return {
+        id: "",
+        title: "",
+        workspaceId: "",
+        active: false,
+        fullscreen: false,
+        x: 0,
+        y: 0,
+        width: 0,
+        height: 0,
+        app: undefined,
+    };
 }
 exports.Window = {
     encode(message, writer = new wire_1.BinaryWriter()) {
         if (message.id !== "") {
             writer.uint32(10).string(message.id);
         }
+        if (message.title !== "") {
+            writer.uint32(18).string(message.title);
+        }
         if (message.workspaceId !== "") {
-            writer.uint32(18).string(message.workspaceId);
+            writer.uint32(26).string(message.workspaceId);
         }
         if (message.active !== false) {
-            writer.uint32(24).bool(message.active);
+            writer.uint32(32).bool(message.active);
         }
         if (message.fullscreen !== false) {
-            writer.uint32(32).bool(message.fullscreen);
+            writer.uint32(40).bool(message.fullscreen);
         }
         if (message.x !== 0) {
-            writer.uint32(40).int32(message.x);
+            writer.uint32(48).int32(message.x);
         }
         if (message.y !== 0) {
-            writer.uint32(48).int32(message.y);
+            writer.uint32(56).int32(message.y);
         }
         if (message.width !== 0) {
-            writer.uint32(56).int32(message.width);
+            writer.uint32(64).int32(message.width);
         }
         if (message.height !== 0) {
-            writer.uint32(64).int32(message.height);
+            writer.uint32(72).int32(message.height);
         }
         if (message.app !== undefined) {
-            application_1.Application.encode(message.app, writer.uint32(74).fork()).join();
+            application_1.Application.encode(message.app, writer.uint32(82).fork()).join();
         }
         return writer;
     },
@@ -62,53 +76,60 @@ exports.Window = {
                     if (tag !== 18) {
                         break;
                     }
-                    message.workspaceId = reader.string();
+                    message.title = reader.string();
                     continue;
                 }
                 case 3: {
-                    if (tag !== 24) {
+                    if (tag !== 26) {
                         break;
                     }
-                    message.active = reader.bool();
+                    message.workspaceId = reader.string();
                     continue;
                 }
                 case 4: {
                     if (tag !== 32) {
                         break;
                     }
-                    message.fullscreen = reader.bool();
+                    message.active = reader.bool();
                     continue;
                 }
                 case 5: {
                     if (tag !== 40) {
                         break;
                     }
-                    message.x = reader.int32();
+                    message.fullscreen = reader.bool();
                     continue;
                 }
                 case 6: {
                     if (tag !== 48) {
                         break;
                     }
-                    message.y = reader.int32();
+                    message.x = reader.int32();
                     continue;
                 }
                 case 7: {
                     if (tag !== 56) {
                         break;
                     }
-                    message.width = reader.int32();
+                    message.y = reader.int32();
                     continue;
                 }
                 case 8: {
                     if (tag !== 64) {
                         break;
                     }
-                    message.height = reader.int32();
+                    message.width = reader.int32();
                     continue;
                 }
                 case 9: {
-                    if (tag !== 74) {
+                    if (tag !== 72) {
+                        break;
+                    }
+                    message.height = reader.int32();
+                    continue;
+                }
+                case 10: {
+                    if (tag !== 82) {
                         break;
                     }
                     message.app = application_1.Application.decode(reader, reader.uint32());
@@ -125,6 +146,7 @@ exports.Window = {
     fromJSON(object) {
         return {
             id: isSet(object.id) ? globalThis.String(object.id) : "",
+            title: isSet(object.title) ? globalThis.String(object.title) : "",
             workspaceId: isSet(object.workspaceId) ? globalThis.String(object.workspaceId) : "",
             active: isSet(object.active) ? globalThis.Boolean(object.active) : false,
             fullscreen: isSet(object.fullscreen) ? globalThis.Boolean(object.fullscreen) : false,
@@ -140,6 +162,9 @@ exports.Window = {
         if (message.id !== "") {
             obj.id = message.id;
         }
+        if (message.title !== "") {
+            obj.title = message.title;
+        }
         if (message.workspaceId !== "") {
             obj.workspaceId = message.workspaceId;
         }
@@ -172,6 +197,7 @@ exports.Window = {
     fromPartial(object) {
         const message = createBaseWindow();
         message.id = object.id ?? "";
+        message.title = object.title ?? "";
         message.workspaceId = object.workspaceId ?? "";
         message.active = object.active ?? false;
         message.fullscreen = object.fullscreen ?? false;
@@ -542,6 +568,108 @@ exports.PingResponse = {
         return message;
     },
 };
+function createBaseFocusWindowRequest() {
+    return { id: "" };
+}
+exports.FocusWindowRequest = {
+    encode(message, writer = new wire_1.BinaryWriter()) {
+        if (message.id !== "") {
+            writer.uint32(10).string(message.id);
+        }
+        return writer;
+    },
+    decode(input, length) {
+        const reader = input instanceof wire_1.BinaryReader ? input : new wire_1.BinaryReader(input);
+        const end = length === undefined ? reader.len : reader.pos + length;
+        const message = createBaseFocusWindowRequest();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1: {
+                    if (tag !== 10) {
+                        break;
+                    }
+                    message.id = reader.string();
+                    continue;
+                }
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skip(tag & 7);
+        }
+        return message;
+    },
+    fromJSON(object) {
+        return { id: isSet(object.id) ? globalThis.String(object.id) : "" };
+    },
+    toJSON(message) {
+        const obj = {};
+        if (message.id !== "") {
+            obj.id = message.id;
+        }
+        return obj;
+    },
+    create(base) {
+        return exports.FocusWindowRequest.fromPartial(base ?? {});
+    },
+    fromPartial(object) {
+        const message = createBaseFocusWindowRequest();
+        message.id = object.id ?? "";
+        return message;
+    },
+};
+function createBaseFocusWindowResponse() {
+    return { ok: false };
+}
+exports.FocusWindowResponse = {
+    encode(message, writer = new wire_1.BinaryWriter()) {
+        if (message.ok !== false) {
+            writer.uint32(8).bool(message.ok);
+        }
+        return writer;
+    },
+    decode(input, length) {
+        const reader = input instanceof wire_1.BinaryReader ? input : new wire_1.BinaryReader(input);
+        const end = length === undefined ? reader.len : reader.pos + length;
+        const message = createBaseFocusWindowResponse();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1: {
+                    if (tag !== 8) {
+                        break;
+                    }
+                    message.ok = reader.bool();
+                    continue;
+                }
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skip(tag & 7);
+        }
+        return message;
+    },
+    fromJSON(object) {
+        return { ok: isSet(object.ok) ? globalThis.Boolean(object.ok) : false };
+    },
+    toJSON(message) {
+        const obj = {};
+        if (message.ok !== false) {
+            obj.ok = message.ok;
+        }
+        return obj;
+    },
+    create(base) {
+        return exports.FocusWindowResponse.fromPartial(base ?? {});
+    },
+    fromPartial(object) {
+        const message = createBaseFocusWindowResponse();
+        message.ok = object.ok ?? false;
+        return message;
+    },
+};
 function createBaseGetActiveWindowRequest() {
     return {};
 }
@@ -1212,6 +1340,7 @@ function createBaseRequest() {
         getScreens: undefined,
         getWorkspaces: undefined,
         setWindowBounds: undefined,
+        focusWindow: undefined,
     };
 }
 exports.Request = {
@@ -1237,6 +1366,9 @@ exports.Request = {
         if (message.setWindowBounds !== undefined) {
             exports.SetWindowBoundsRequest.encode(message.setWindowBounds, writer.uint32(58).fork()).join();
         }
+        if (message.focusWindow !== undefined) {
+            exports.FocusWindowRequest.encode(message.focusWindow, writer.uint32(66).fork()).join();
+        }
         return writer;
     },
     decode(input, length) {
@@ -1295,6 +1427,13 @@ exports.Request = {
                     message.setWindowBounds = exports.SetWindowBoundsRequest.decode(reader, reader.uint32());
                     continue;
                 }
+                case 8: {
+                    if (tag !== 66) {
+                        break;
+                    }
+                    message.focusWindow = exports.FocusWindowRequest.decode(reader, reader.uint32());
+                    continue;
+                }
             }
             if ((tag & 7) === 4 || tag === 0) {
                 break;
@@ -1318,6 +1457,7 @@ exports.Request = {
             setWindowBounds: isSet(object.setWindowBounds)
                 ? exports.SetWindowBoundsRequest.fromJSON(object.setWindowBounds)
                 : undefined,
+            focusWindow: isSet(object.focusWindow) ? exports.FocusWindowRequest.fromJSON(object.focusWindow) : undefined,
         };
     },
     toJSON(message) {
@@ -1343,6 +1483,9 @@ exports.Request = {
         if (message.setWindowBounds !== undefined) {
             obj.setWindowBounds = exports.SetWindowBoundsRequest.toJSON(message.setWindowBounds);
         }
+        if (message.focusWindow !== undefined) {
+            obj.focusWindow = exports.FocusWindowRequest.toJSON(message.focusWindow);
+        }
         return obj;
     },
     create(base) {
@@ -1371,6 +1514,9 @@ exports.Request = {
         message.setWindowBounds = (object.setWindowBounds !== undefined && object.setWindowBounds !== null)
             ? exports.SetWindowBoundsRequest.fromPartial(object.setWindowBounds)
             : undefined;
+        message.focusWindow = (object.focusWindow !== undefined && object.focusWindow !== null)
+            ? exports.FocusWindowRequest.fromPartial(object.focusWindow)
+            : undefined;
         return message;
     },
 };
@@ -1383,6 +1529,7 @@ function createBaseResponse() {
         getScreens: undefined,
         getWorkspaces: undefined,
         setWindowBounds: undefined,
+        focusWindow: undefined,
     };
 }
 exports.Response = {
@@ -1408,6 +1555,9 @@ exports.Response = {
         if (message.setWindowBounds !== undefined) {
             exports.SetWindowBoundsResponse.encode(message.setWindowBounds, writer.uint32(58).fork()).join();
         }
+        if (message.focusWindow !== undefined) {
+            exports.FocusWindowResponse.encode(message.focusWindow, writer.uint32(66).fork()).join();
+        }
         return writer;
     },
     decode(input, length) {
@@ -1466,6 +1616,13 @@ exports.Response = {
                     message.setWindowBounds = exports.SetWindowBoundsResponse.decode(reader, reader.uint32());
                     continue;
                 }
+                case 8: {
+                    if (tag !== 66) {
+                        break;
+                    }
+                    message.focusWindow = exports.FocusWindowResponse.decode(reader, reader.uint32());
+                    continue;
+                }
             }
             if ((tag & 7) === 4 || tag === 0) {
                 break;
@@ -1489,6 +1646,7 @@ exports.Response = {
             setWindowBounds: isSet(object.setWindowBounds)
                 ? exports.SetWindowBoundsResponse.fromJSON(object.setWindowBounds)
                 : undefined,
+            focusWindow: isSet(object.focusWindow) ? exports.FocusWindowResponse.fromJSON(object.focusWindow) : undefined,
         };
     },
     toJSON(message) {
@@ -1514,6 +1672,9 @@ exports.Response = {
         if (message.setWindowBounds !== undefined) {
             obj.setWindowBounds = exports.SetWindowBoundsResponse.toJSON(message.setWindowBounds);
         }
+        if (message.focusWindow !== undefined) {
+            obj.focusWindow = exports.FocusWindowResponse.toJSON(message.focusWindow);
+        }
         return obj;
     },
     create(base) {
@@ -1542,6 +1703,9 @@ exports.Response = {
         message.setWindowBounds = (object.setWindowBounds !== undefined && object.setWindowBounds !== null)
             ? exports.SetWindowBoundsResponse.fromPartial(object.setWindowBounds)
             : undefined;
+        message.focusWindow = (object.focusWindow !== undefined && object.focusWindow !== null)
+            ? exports.FocusWindowResponse.fromPartial(object.focusWindow)
+            : undefined;
         return message;
     },
 };

package/dist/api/toast.d.ts

@@ -16,6 +16,8 @@ import { Keyboard } from "./keyboard";
  *   toast.title = "Uploaded image";
  * };
  * ```
+ *
+ * @category Toast
  */
 export declare class Toast {
     private options;
@@ -65,6 +67,9 @@ export declare class Toast {
      */
     hide(): Promise<void>;
 }
+/**
+ * @category Toast
+ */
 export declare namespace Toast {
     /**
      * The options to create a {@link Toast}.
@@ -156,4 +161,7 @@ export declare interface ToastOptions extends Toast.Options {
  * @deprecated Use {@link Toast.Style} instead
  */
 export declare const ToastStyle: typeof Toast.Style;
+/**
+ * @category Toast
+ */
 export declare const showToast: (init: Toast.Style | Toast.Options, title?: string, message?: string) => Promise<Toast>;

package/dist/api/toast.js

@@ -54,6 +54,8 @@ const ui = __importStar(require("./proto/ui"));
  *   toast.title = "Uploaded image";
  * };
  * ```
+ *
+ * @category Toast
  */
 class Toast {
     options;
@@ -184,6 +186,9 @@ class Toast {
     }
 }
 exports.Toast = Toast;
+/**
+ * @category Toast
+ */
 (function (Toast) {
     /**
      * Defines the visual style of the Toast.
@@ -200,6 +205,9 @@ exports.Toast = Toast;
         Style["Animated"] = "animated";
     })(Style = Toast.Style || (Toast.Style = {}));
 })(Toast || (exports.Toast = Toast = {}));
+/**
+ * @category Toast
+ */
 const showToast = async (init, title = "", message) => {
     const toast = typeof init === "string"
         ? new Toast({ style: init, message, title })

package/dist/api/utils.d.ts

@@ -1,11 +1,16 @@
-import { PathLike } from "fs";
-import { Application } from "./proto/application";
+import type { PathLike } from "node:fs";
+import type { Application } from "./proto/application";
+/**
+  @ignore - we should probably move this to raycast compat, I don't think we want that.
+ */
 export declare const trash: (path: PathLike | PathLike[]) => Promise<void>;
 /**
  * Additional options that can be passed in order to tweak the behavior of the terminal window.
  * Note that most options are best-effort, which means that they may or may not work depending on
  * the default terminal emulator that is available.
  * On Linux, Vicinae honors the xdg-terminal-exec specification: https://gitlab.freedesktop.org/terminal-wg/specifications/-/merge_requests/3/diffs
+ *
+ * @category System
  */
 export type RunInTerminalOptions = {
     /**
@@ -42,11 +47,28 @@ export type RunInTerminalOptions = {
  * // or, inside a shell:
  * await runInTerminal(['/bin/bash', 'echo "dis is my home: $HOME"'], { hold: true });
  * ```
+ *
+ * @category System
  */
 export declare const runInTerminal: (args: string[], options?: RunInTerminalOptions) => Promise<void>;
+/**
+ * @category System
+ */
 export declare const open: (target: string, app?: Application | string) => Promise<void>;
+/**
+ * @category System
+ */
 export declare const getFrontmostApplication: () => Promise<Application>;
+/**
+ * @category System
+ */
 export declare const getApplications: (target?: string) => Promise<Application[]>;
+/**
+ * @category System
+ */
 export declare const getDefaultApplication: (path: string) => Promise<Application>;
+/**
+ * @category System
+ */
 export declare const showInFileBrowser: (path: PathLike) => Promise<void>;
 export { Application } from "./proto/application";

package/dist/api/utils.js

@@ -1,10 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Application = exports.showInFileBrowser = exports.getDefaultApplication = exports.getApplications = exports.getFrontmostApplication = exports.open = exports.runInTerminal = exports.trash = void 0;
-const promises_1 = require("fs/promises");
+const promises_1 = require("node:fs/promises");
 const bus_1 = require("./bus");
 const window_management_1 = require("./window-management");
-// Linux systems usually do not have a trash, but maybe we should support one...
+/**
+  @ignore - we should probably move this to raycast compat, I don't think we want that.
+ */
 const trash = async (path) => {
     const targets = Array.isArray(path) ? path : [path];
     const promises = targets.map((p) => (0, promises_1.rm)(p, { recursive: true }));
@@ -23,6 +25,8 @@ exports.trash = trash;
  * // or, inside a shell:
  * await runInTerminal(['/bin/bash', 'echo "dis is my home: $HOME"'], { hold: true });
  * ```
+ *
+ * @category System
  */
 const runInTerminal = async (args, options = {}) => {
     const { hold = false, appId, title } = options;
@@ -34,6 +38,9 @@ const runInTerminal = async (args, options = {}) => {
     });
 };
 exports.runInTerminal = runInTerminal;
+/**
+ * @category System
+ */
 const open = async (target, app) => {
     let appId;
     if (app) {
@@ -50,6 +57,9 @@ const open = async (target, app) => {
     });
 };
 exports.open = open;
+/**
+ * @category System
+ */
 const getFrontmostApplication = async () => {
     const { application } = await window_management_1.WindowManagement.getActiveWindow();
     if (!application) {
@@ -58,11 +68,17 @@ const getFrontmostApplication = async () => {
     return application;
 };
 exports.getFrontmostApplication = getFrontmostApplication;
+/**
+ * @category System
+ */
 const getApplications = async (target) => {
     const res = await bus_1.bus.turboRequest("app.list", { target });
     return res.unwrap().apps;
 };
 exports.getApplications = getApplications;
+/**
+ * @category System
+ */
 const getDefaultApplication = async (path) => {
     const res = await bus_1.bus.turboRequest("app.getDefault", { target: path });
     const app = res.unwrap().app;
@@ -71,6 +87,9 @@ const getDefaultApplication = async (path) => {
     return app;
 };
 exports.getDefaultApplication = getDefaultApplication;
+/**
+ * @category System
+ */
 const showInFileBrowser = async (path) => {
     const fileBrowser = await (0, exports.getDefaultApplication)("inode/directory"); // FIXME: we may want something more robust
     await (0, exports.open)(path.toString(), fileBrowser);

package/dist/api/window-management.d.ts

@@ -4,21 +4,36 @@ import * as wm from "./proto/wm";
  * 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
  */
 export declare namespace WindowManagement {
+    /**
+     * A window as defined by the windowing system in use.
+     * A window can be optionally tied to an application or a workspace.
+     */
     type Window = {
         id: string;
+        title: string;
+        /**
+         * Whether this window is currently active.
+         * This is usually the window that currently owns focus.
+         */
         active: boolean;
         bounds: {
             position: {
@@ -30,8 +45,20 @@ export declare namespace WindowManagement {
                 width: number;
             };
         };
+        /**
+         * The ID of the workspace this window belongs to, if applicable in the context
+         * of the current window manager.
+         */
         workspaceId?: string;
+        /**
+         * The application this window belongs to, if any.
+         */
         application?: Application;
+        /**
+         * Request that the window manager focuses this window.
+         * @see {@link focusWindow}
+         */
+        focus: () => Promise<boolean>;
     };
     type Workspace = {
         id: string;
@@ -43,6 +70,13 @@ export declare namespace WindowManagement {
      * A screen, physical or virtual, attached to this computer.
      */
     type Screen = {
+        /**
+         * Name assigned by the windowing system to that screen.
+         *
+         * In Wayland environments for instance, the name is set to something like `DP-1`, `DP-2`, `e-DP1`...
+         *
+         * @remarks The name is not guaranteed to remain stable but is usually stable enough to uniquely identify a screen.
+         */
         name: string;
         /**
          * Name of the screen's manufacturer.
@@ -64,8 +98,22 @@ export declare namespace WindowManagement {
             };
         };
     };
-    function ping(): Promise<boolean>;
     function getWindows(options?: wm.GetWindowsRequest): Promise<WindowManagement.Window[]>;
+    /**
+     * 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}
+     */
+    function focusWindow(window: Window): Promise<boolean>;
     /**
      * Return the list of screens (physical and virtual) currently attached to the computer.
      */