@vicinae/api 0.16.6 → 0.16.8

package/dist/api/bus.d.ts

@@ -60,6 +60,7 @@ type EndpointMapping = {
     "wm.getScreens": "wm.getScreens";
     "wm.getWorkspaces": "wm.getWorkspaces";
     "wm.setWindowBounds": "wm.setWindowBounds";
+    "wm.focusWindow": "wm.focusWindow";
     "fileSearch.search": "fileSearch.search";
     "ui.popToRoot": "ui.popToRoot";
     "command.updateCommandMetadata": "command.updateCommandMetadata";

package/dist/api/clipboard.d.ts

@@ -33,7 +33,7 @@ export declare namespace Clipboard {
      * or pasting content to it directly, this will fallback to a regular
      * clipboard copy.
      */
-    function paste(text: string | Clipboard.Content): Promise<void>;
+    function paste(text: string | number | Clipboard.Content): Promise<void>;
     /**
      * Read the current content of the clipboard, which can contain text, html and a file path.
      * Note: the offset option is not yet implemented

package/dist/api/clipboard.js

@@ -12,7 +12,7 @@ var Clipboard;
 (function (Clipboard) {
     function mapContent(content) {
         let ct = clipboard_1.ClipboardContent.create();
-        if (typeof content != "object") {
+        if (typeof content !== "object") {
             ct.text = `${content}`;
         }
         else {

package/dist/api/image.js

@@ -66,7 +66,11 @@ const serializeProtoImage = (image) => {
     }
     const proto = ui.Image.create();
     const img = image;
-    proto.source = serializeSource(img.source);
+    // img.source should technically not be null, but it somehow still happens at times with some
+    // raycast extensions
+    if (img.source) {
+        proto.source = serializeSource(img.source);
+    }
     if (img.fallback) {
         proto.fallback = serializeSource(img.fallback);
     }

package/dist/api/proto/wm.d.ts

@@ -3,6 +3,7 @@ import { Application } from "./application";
 export declare const protobufPackage = "proto.ext.wm";
 export interface Window {
     id: string;
+    title: string;
     workspaceId: string;
     active: boolean;
     fullscreen: boolean;
@@ -34,6 +35,12 @@ export interface PingRequest {
 export interface PingResponse {
     ok: boolean;
 }
+export interface FocusWindowRequest {
+    id: string;
+}
+export interface FocusWindowResponse {
+    ok: boolean;
+}
 export interface GetActiveWindowRequest {
 }
 export interface GetActiveWindowResponse {
@@ -79,6 +86,7 @@ export interface Request {
     getScreens?: GetScreensRequest | undefined;
     getWorkspaces?: GetWorkspacesRequest | undefined;
     setWindowBounds?: SetWindowBoundsRequest | undefined;
+    focusWindow?: FocusWindowRequest | undefined;
 }
 export interface Response {
     ping?: PingResponse | undefined;
@@ -88,12 +96,15 @@ export interface Response {
     getScreens?: GetScreensResponse | undefined;
     getWorkspaces?: GetWorkspacesResponse | undefined;
     setWindowBounds?: SetWindowBoundsResponse | undefined;
+    focusWindow?: FocusWindowResponse | undefined;
 }
 export declare const Window: MessageFns<Window>;
 export declare const Screen: MessageFns<Screen>;
 export declare const Workspace: MessageFns<Workspace>;
 export declare const PingRequest: MessageFns<PingRequest>;
 export declare const PingResponse: MessageFns<PingResponse>;
+export declare const FocusWindowRequest: MessageFns<FocusWindowRequest>;
+export declare const FocusWindowResponse: MessageFns<FocusWindowResponse>;
 export declare const GetActiveWindowRequest: MessageFns<GetActiveWindowRequest>;
 export declare const GetActiveWindowResponse: MessageFns<GetActiveWindowResponse>;
 export declare const GetWorkspacesRequest: MessageFns<GetWorkspacesRequest>;

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/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.
      */

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,6 +1,6 @@
 {
 	"name": "@vicinae/api",
-	"version": "0.16.6",
+	"version": "0.16.8",
 	"description": "TypeScript SDK to build Vicinae extensions",
 	"scripts": {
 		"test": "echo \"Error: no test specified\" && exit 1",