@vicinae/api 0.9.1 → 0.9.2

package/dist/api/raycast/index.d.ts

@@ -0,0 +1,24 @@
+/**
+ * This entrypoint is used instead of the normal index.ts when we are
+ * dealing with a Raycast extension, e.g an extension that makes use of
+ * `@raycast/api` package instead of `@vicinae/api`.
+ */
+export * from "../components/index.js";
+export * from "../hooks/index.js";
+export * from "../context/index.js";
+export * from "../bus.js";
+export * from "../color.js";
+export * from "../keyboard.js";
+export * from "../image.js";
+export * from "../icon.js";
+export * from "../environment.js";
+export * from "../controls.js";
+export * from "../cache";
+export * from "../toast";
+export * from "../clipboard.js";
+export * from "../local-storage.js";
+export * from "../oauth.js";
+export * from "../alert.js";
+export * from "../preference.js";
+export * from "./system.js";
+export * from './window-management.js';

package/dist/api/raycast/index.js

@@ -0,0 +1,40 @@
+"use strict";
+/**
+ * This entrypoint is used instead of the normal index.ts when we are
+ * dealing with a Raycast extension, e.g an extension that makes use of
+ * `@raycast/api` package instead of `@vicinae/api`.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("../components/index.js"), exports);
+__exportStar(require("../hooks/index.js"), exports);
+__exportStar(require("../context/index.js"), exports);
+__exportStar(require("../bus.js"), exports);
+__exportStar(require("../color.js"), exports);
+__exportStar(require("../keyboard.js"), exports);
+__exportStar(require("../image.js"), exports);
+__exportStar(require("../icon.js"), exports);
+__exportStar(require("../environment.js"), exports);
+__exportStar(require("../controls.js"), exports);
+__exportStar(require("../cache"), exports);
+__exportStar(require("../toast"), exports);
+__exportStar(require("../clipboard.js"), exports);
+__exportStar(require("../local-storage.js"), exports);
+__exportStar(require("../oauth.js"), exports);
+__exportStar(require("../alert.js"), exports);
+__exportStar(require("../preference.js"), exports);
+__exportStar(require("./system.js"), exports);
+__exportStar(require("./window-management.js"), exports);

package/dist/api/raycast/system.d.ts

@@ -0,0 +1,20 @@
+import { PathLike } from 'fs';
+import * as vicinae from '..';
+export type RaycastApplication = {
+    name: string;
+    path: string;
+    bundleId: string;
+    localizedName: string;
+    windowsAppId: string;
+};
+export declare const transformApp: (app: vicinae.Application) => RaycastApplication;
+export declare const getApplications: (path?: PathLike) => Promise<RaycastApplication[]>;
+export declare const getDefaultApplication: (path: PathLike) => Promise<RaycastApplication>;
+export declare const open: (target: string, app?: vicinae.Application | string) => Promise<void>;
+export declare const trash: (path: PathLike | PathLike[]) => Promise<void>;
+export declare const getFrontmostApplication: () => Promise<RaycastApplication>;
+export declare const captureException: (exception: unknown) => void;
+export declare const showInFinder: (path: PathLike) => Promise<void>;
+export declare const getSelectedFinderItems: () => Promise<{
+    path: string;
+}[]>;

package/dist/api/raycast/system.js

@@ -0,0 +1,73 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSelectedFinderItems = exports.showInFinder = exports.captureException = exports.getFrontmostApplication = exports.trash = exports.open = exports.getDefaultApplication = exports.getApplications = exports.transformApp = void 0;
+const vicinae = __importStar(require(".."));
+const transformApp = (app) => {
+    return {
+        bundleId: app.id,
+        name: app.name,
+        path: app.path,
+        localizedName: app.name,
+        windowsAppId: app.id,
+    };
+};
+exports.transformApp = transformApp;
+const getApplications = async (path) => {
+    const apps = await vicinae.getApplications(path?.toString());
+    return apps.map(exports.transformApp);
+};
+exports.getApplications = getApplications;
+const getDefaultApplication = async (path) => {
+    return (0, exports.transformApp)(await vicinae.getDefaultApplication(path.toString()));
+};
+exports.getDefaultApplication = getDefaultApplication;
+exports.open = vicinae.open;
+exports.trash = vicinae.trash;
+const getFrontmostApplication = async () => {
+    return (0, exports.transformApp)(await vicinae.getFrontmostApplication());
+};
+exports.getFrontmostApplication = getFrontmostApplication;
+const captureException = (exception) => {
+    // maybe one day, if we have a developer hub...
+    console.error("captureException called on", exception);
+};
+exports.captureException = captureException;
+const showInFinder = (path) => vicinae.showInFileBrowser(path);
+exports.showInFinder = showInFinder;
+const getSelectedFinderItems = async () => {
+    throw new Error('getSelectedFinderItems is not implemented');
+};
+exports.getSelectedFinderItems = getSelectedFinderItems;

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

@@ -0,0 +1,42 @@
+import { RaycastApplication } from './system';
+type RaycastWindow = {
+    active: boolean;
+    bounds: {
+        position: {
+            x: number;
+            y: number;
+        };
+        size: {
+            height: number;
+            width: number;
+        };
+    } | "fullscreen";
+    desktopId: string;
+    fullScreenSettable: boolean;
+    id: string;
+    positionable: boolean;
+    resizable: boolean;
+    application?: RaycastApplication;
+};
+declare enum DesktopType {
+    User = 0,
+    FullScreen = 1
+}
+type RaycastDesktop = {
+    id: string;
+    screenId: string;
+    size: {
+        height: number;
+        width: number;
+    };
+    active: boolean;
+    type: DesktopType;
+};
+declare class RaycastWindowManagement {
+    getActiveWindow(): Promise<RaycastWindow>;
+    getDesktops(): Promise<RaycastDesktop[]>;
+    getWindowsOnActiveDesktop(): Promise<RaycastWindow[]>;
+    constructor();
+}
+export declare const WindowManagement: RaycastWindowManagement;
+export {};

package/dist/api/raycast/window-management.js

@@ -0,0 +1,82 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WindowManagement = void 0;
+const system_1 = require("./system");
+const vicinae = __importStar(require(".."));
+var DesktopType;
+(function (DesktopType) {
+    DesktopType[DesktopType["User"] = 0] = "User";
+    DesktopType[DesktopType["FullScreen"] = 1] = "FullScreen";
+})(DesktopType || (DesktopType = {}));
+;
+const transformNativeDesktop = (win) => {
+    return {
+        id: win.id,
+        screenId: win.monitorId,
+        size: { width: 0, height: 0 }, // FIXME: implement
+        active: win.active,
+        type: DesktopType.User
+    };
+};
+const transformNativeWindow = (win) => {
+    return {
+        id: win.id,
+        fullScreenSettable: true,
+        positionable: true,
+        resizable: true,
+        active: win.active,
+        bounds: win.bounds,
+        desktopId: win.workspaceId ?? '0',
+        application: win.application && (0, system_1.transformApp)(win.application)
+    };
+};
+class RaycastWindowManagement {
+    async getActiveWindow() {
+        const window = await vicinae.WindowManagement.getActiveWindow();
+        return transformNativeWindow(window);
+    }
+    async getDesktops() {
+        const workspaces = await vicinae.WindowManagement.getWorkspaces();
+        return workspaces.map(transformNativeDesktop);
+    }
+    async getWindowsOnActiveDesktop() {
+        const wins = await vicinae.WindowManagement.getWindowsOnActiveWorkspace();
+        return wins.map(transformNativeWindow);
+    }
+    constructor() { }
+}
+;
+exports.WindowManagement = new RaycastWindowManagement;

package/dist/api/toast.js

@@ -1,9 +1,42 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.showHUD = exports.PopToRootType = exports.showToast = exports.Toast = void 0;
 const crypto_1 = require("crypto");
 const bus_1 = require("./bus");
-const ui_1 = require("./proto/ui");
+const ui = __importStar(require("./proto/ui"));
 /**
  * A Toast with a certain style, title, and message.
  *
@@ -27,9 +60,9 @@ class Toast {
     callbacks = {};
     id;
     styleMap = {
-        [Toast.Style.Success]: ui_1.ToastStyle.Success,
-        [Toast.Style.Failure]: ui_1.ToastStyle.Error,
-        [Toast.Style.Animated]: ui_1.ToastStyle.Dynamic,
+        [Toast.Style.Success]: ui.ToastStyle.Success,
+        [Toast.Style.Failure]: ui.ToastStyle.Error,
+        [Toast.Style.Animated]: ui.ToastStyle.Dynamic,
     };
     /**
      * Deprecated - Use `showToast` instead
@@ -173,7 +206,16 @@ var PopToRootType;
     PopToRootType["Immediate"] = "immediate";
     PopToRootType["Suspended"] = "suspended";
 })(PopToRootType || (exports.PopToRootType = PopToRootType = {}));
+const popToRootProtoMap = {
+    [PopToRootType.Default]: ui.PopToRootType.PopToRootDefault,
+    [PopToRootType.Immediate]: ui.PopToRootType.PopToRootImmediate,
+    [PopToRootType.Suspended]: ui.PopToRootType.PopToRootSuspended,
+};
 const showHUD = async (title, options) => {
-    await bus_1.bus.request("ui.show-hud", { title, options });
+    bus_1.bus.turboRequest('ui.showHud', {
+        text: title,
+        clearRootSearch: options?.clearRootSearch ?? false,
+        popToRoot: popToRootProtoMap[options?.popToRootType ?? PopToRootType.Default]
+    });
 };
 exports.showHUD = showHUD;

package/dist/api/utils.d.ts

@@ -1,15 +1,9 @@
 import { PathLike } from "fs";
-export declare const captureException: (exception: unknown) => void;
+import { Application } from "./proto/application";
 export declare const trash: (path: PathLike | PathLike[]) => Promise<void>;
 export declare const open: (target: string, app?: Application | string) => Promise<void>;
-export type Application = {
-    id: string;
-    name: string;
-    icon: {
-        iconName: string;
-    };
-};
 export declare const getFrontmostApplication: () => Promise<Application>;
-export declare const getApplications: (path?: PathLike) => Promise<Application[]>;
-export declare const getDefaultApplication: (path: PathLike) => Promise<Application>;
-export declare const showInFinder: (path: PathLike) => Promise<void>;
+export declare const getApplications: (target?: string) => Promise<Application[]>;
+export declare const getDefaultApplication: (path: string) => Promise<Application>;
+export declare const showInFileBrowser: (path: PathLike) => Promise<void>;
+export { Application } from "./proto/application";

package/dist/api/utils.js

@@ -1,13 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.showInFinder = exports.getDefaultApplication = exports.getApplications = exports.getFrontmostApplication = exports.open = exports.trash = exports.captureException = void 0;
+exports.Application = exports.showInFileBrowser = exports.getDefaultApplication = exports.getApplications = exports.getFrontmostApplication = exports.open = exports.trash = void 0;
 const promises_1 = require("fs/promises");
 const bus_1 = require("./bus");
-const captureException = (exception) => {
-    // maybe one day, if we have a developer hub, also...
-    console.error("captureException called on", exception);
-};
-exports.captureException = captureException;
+const window_management_1 = require("./window-management");
 // Linux systems usually do not have a trash, but maybe we should support one...
 const trash = async (path) => {
     const targets = Array.isArray(path) ? path : [path];
@@ -31,38 +27,31 @@ const open = async (target, app) => {
     });
 };
 exports.open = open;
-const deserializeApp = (app) => ({
-    id: app.id,
-    name: app.name,
-    icon: { iconName: app.icon },
-});
 const getFrontmostApplication = async () => {
-    const res = await bus_1.bus.request("apps.get-frontmost");
-    if (!res.data.app) {
-        throw new Error("couldnt get frontmost app");
+    const { application } = await window_management_1.WindowManagement.getActiveWindow();
+    if (!application) {
+        throw new Error(`Could not get frontmost application`);
     }
-    return deserializeApp(res.data.app);
+    return application;
 };
 exports.getFrontmostApplication = getFrontmostApplication;
-const getApplications = async (path) => {
-    const res = await bus_1.bus.turboRequest("app.list", {});
-    if (!res.ok)
-        return [];
-    console.log("got turbo apps", { apps: res.value });
-    return [];
+const getApplications = async (target) => {
+    const res = await bus_1.bus.turboRequest("app.list", { target });
+    return res.unwrap().apps;
 };
 exports.getApplications = getApplications;
 const getDefaultApplication = async (path) => {
-    const res = await bus_1.bus.request("apps.get-default", {
-        target: path.toString(),
-    });
-    if (!res.data.app) {
-        throw new Error("couldnt get default app");
-    }
-    return deserializeApp(res.data.app);
+    const res = await bus_1.bus.turboRequest('app.getDefault', { target: path });
+    const app = res.unwrap().app;
+    if (!app)
+        throw new Error(`No default application for target ${path}`);
+    return app;
 };
 exports.getDefaultApplication = getDefaultApplication;
-const showInFinder = async (path) => {
-    await bus_1.bus.request("show-in-finder");
+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);
 };
-exports.showInFinder = showInFinder;
+exports.showInFileBrowser = showInFileBrowser;
+var application_1 = require("./proto/application");
+Object.defineProperty(exports, "Application", { enumerable: true, get: function () { return application_1.Application; } });

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

@@ -0,0 +1,39 @@
+import { Application } from './proto/application';
+import * as wm from './proto/wm';
+export declare namespace WindowManagement {
+    type Window = {
+        id: string;
+        active: boolean;
+        bounds: {
+            position: {
+                x: number;
+                y: number;
+            };
+            size: {
+                height: number;
+                width: number;
+            };
+        };
+        workspaceId?: string;
+        application?: Application;
+    };
+    type Workspace = {
+        id: string;
+        name: string;
+        monitorId: string;
+        active: boolean;
+    };
+}
+/**
+ */
+declare class WindowManagementImpl {
+    ping(): Promise<boolean>;
+    getWindows(options?: wm.GetWindowsRequest): Promise<WindowManagement.Window[]>;
+    getActiveWorkspace(): Promise<WindowManagement.Workspace>;
+    getWorkspaces(): Promise<WindowManagement.Workspace[]>;
+    getWindowsOnActiveWorkspace(): Promise<WindowManagement.Window[]>;
+    setWindowBounds(payload: wm.SetWindowBoundsRequest): Promise<void>;
+    getActiveWindow(): Promise<WindowManagement.Window>;
+}
+export declare const WindowManagement: WindowManagementImpl;
+export {};

package/dist/api/window-management.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WindowManagement = void 0;
+const bus_1 = require("./bus");
+;
+const transformWorkspace = (proto) => {
+    return {
+        id: proto.id,
+        name: proto.name,
+        active: proto.active,
+        monitorId: proto.monitor
+    };
+};
+const transformWindow = (proto) => {
+    return {
+        id: proto.id,
+        workspaceId: proto.workspaceId,
+        active: proto.active,
+        bounds: { position: { x: proto.x, y: proto.y }, size: { width: proto.width, height: proto.height } },
+        application: proto.app
+    };
+};
+/**
+ */
+class WindowManagementImpl {
+    async ping() {
+        const res = await bus_1.bus.turboRequest('wm.ping', {});
+        return res.unwrap().ok;
+    }
+    async getWindows(options = {}) {
+        const res = await bus_1.bus.turboRequest('wm.getWindows', options);
+        return res.unwrap().windows.map(transformWindow);
+    }
+    async getActiveWorkspace() {
+        const res = await bus_1.bus.turboRequest('wm.getActiveWorkspace', {});
+        return transformWorkspace(res.unwrap().workspace);
+    }
+    async getWorkspaces() {
+        const res = await bus_1.bus.turboRequest('wm.getWorkspaces', {});
+        return res.unwrap().workspaces.map(transformWorkspace);
+    }
+    async getWindowsOnActiveWorkspace() {
+        const workspace = await this.getActiveWorkspace();
+        return this.getWindows({ workspaceId: workspace.id });
+    }
+    async setWindowBounds(payload) {
+        await bus_1.bus.turboRequest('wm.setWindowBounds', payload);
+    }
+    async getActiveWindow() {
+        const res = await bus_1.bus.turboRequest('wm.getActiveWindow', {});
+        return transformWindow(res.unwrap().window);
+    }
+}
+;
+exports.WindowManagement = new WindowManagementImpl();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vicinae/api",
-  "version": "0.9.1",
+  "version": "0.9.2",
   "description": "TypeScript SDK to build Vicinae extensions",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",