@vicinae/api 0.20.9 → 0.20.10

package/dist/api/alert.d.ts

@@ -1,4 +1,4 @@
-import { Image } from "./image";
+import type { Image } from "./image";
 /**
  * @category Alert
  */

package/dist/api/alert.js

@@ -1,9 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.confirmAlert = exports.Alert = void 0;
-const bus_1 = require("./bus");
-const image_1 = require("./image");
-const ui_1 = require("./proto/ui");
+const client_1 = require("./client");
 /**
  * @category Alert
  */
@@ -17,9 +15,9 @@ var Alert;
     })(ActionStyle = Alert.ActionStyle || (Alert.ActionStyle = {}));
 })(Alert || (exports.Alert = Alert = {}));
 const styleMap = {
-    [Alert.ActionStyle.Default]: ui_1.ConfirmAlertActionStyle.Default,
-    [Alert.ActionStyle.Destructive]: ui_1.ConfirmAlertActionStyle.Destructive,
-    [Alert.ActionStyle.Cancel]: ui_1.ConfirmAlertActionStyle.Cancel,
+    [Alert.ActionStyle.Default]: "Default",
+    [Alert.ActionStyle.Destructive]: "Destructive",
+    [Alert.ActionStyle.Cancel]: "Cancel",
 };
 /**
  * Display a confirmation dialog with a cancel and confirm options.
@@ -41,10 +39,10 @@ const styleMap = {
  */
 const confirmAlert = async (options) => {
     return new Promise((resolve) => {
-        const req = ui_1.ConfirmAlertRequest.create({
+        (0, client_1.getClient)().UI.confirmAlert({
             title: options.title,
             description: options.message ?? "Are you sure?",
-            icon: options.icon && (0, image_1.serializeProtoImage)(options.icon),
+            //icon: options.icon && serializeProtoImage(options.icon),
             rememberUserChoice: false,
             primaryAction: {
                 title: options.primaryAction?.title ?? "Confirm",
@@ -54,17 +52,14 @@ const confirmAlert = async (options) => {
                 title: options.dismissAction?.title ?? "Cancel",
                 style: styleMap[options.dismissAction?.style ?? Alert.ActionStyle.Cancel],
             },
-        });
-        bus_1.bus.request("ui.confirmAlert", req).then((res) => {
-            if (!res.ok)
-                return false;
-            if (res.value.confirmed) {
+        }).then((confirmed) => {
+            if (confirmed) {
                 options.primaryAction?.onAction?.();
             }
             else {
                 options.dismissAction?.onAction?.();
             }
-            resolve(res.value.confirmed);
+            resolve(confirmed);
         });
     });
 };

package/dist/api/client.d.ts

@@ -0,0 +1,7 @@
+import type { Client } from "./proto/api";
+/**
+ * Client used to access vicinae capabilities from the extension runtime.
+ * Always use this function instead of caching the client at module load time,
+ * as the client is only initialized after the extension command is activated.
+ */
+export declare const getClient: () => Client;

package/dist/api/client.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getClient = void 0;
+const globals_1 = require("./globals");
+/**
+ * Client used to access vicinae capabilities from the extension runtime.
+ * Always use this function instead of caching the client at module load time,
+ * as the client is only initialized after the extension command is activated.
+ */
+const getClient = () => (0, globals_1.getGlobal)().client;
+exports.getClient = getClient;

package/dist/api/clipboard.d.ts

@@ -1,4 +1,4 @@
-import { PathLike } from "fs";
+import type { PathLike } from "node:fs";
 /**
  * Access system clipboard and clipboard history features.
  *
@@ -14,7 +14,7 @@ export declare namespace Clipboard {
         text?: string;
     };
     type ReadContent = {
-        text: string;
+        text?: string;
         file?: string;
         html?: string;
     };
@@ -42,9 +42,7 @@ export declare namespace Clipboard {
      * const { text, html, file } = await Clipboard.read();
      * ```
      */
-    function read(options?: {
-        offset?: number;
-    }): Promise<Clipboard.ReadContent>;
+    function read(): Promise<Clipboard.ReadContent>;
     /**
      * Read the text representation of the current clipboard data. If the data is not text at all, this
      * returns an empty string.
@@ -55,9 +53,7 @@ export declare namespace Clipboard {
      * const text = await Clipboard.readText();
      * ```
      */
-    function readText(options?: {
-        offset?: number;
-    }): Promise<string>;
+    function readText(): Promise<string>;
     /**
      * Clear the current clipboard content.
      */

package/dist/api/clipboard.js

@@ -1,8 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Clipboard = void 0;
-const bus_1 = require("./bus");
-const clipboard_1 = require("./proto/clipboard");
+const client_1 = require("./client");
 /**
  * Access system clipboard and clipboard history features.
  *
@@ -11,16 +10,17 @@ const clipboard_1 = require("./proto/clipboard");
 var Clipboard;
 (function (Clipboard) {
     function mapContent(content) {
-        let ct = clipboard_1.ClipboardContent.create();
+        let ct = {};
         if (typeof content !== "object") {
             ct.text = `${content}`;
         }
         else {
             if (content["file"]) {
-                ct.path = { path: content["file"] };
+                ct.path = content["file"];
             }
             else if (content["html"]) {
-                ct.html = { html: content["html"], text: content["text"] };
+                ct.html = content["html"];
+                ct.text = content["text"];
             }
             else {
                 ct.text = content["text"];
@@ -34,9 +34,8 @@ var Clipboard;
      * does not get indexed by the Vicinae clipboard manager.
      */
     async function copy(text, options = {}) {
-        await bus_1.bus.request("clipboard.copy", {
-            content: mapContent(text),
-            options: { concealed: options.concealed ?? false },
+        await (0, client_1.getClient)().Clipboard.copy(mapContent(text), {
+            concealed: options.concealed ?? false,
         });
     }
     Clipboard.copy = copy;
@@ -47,9 +46,7 @@ var Clipboard;
      * clipboard copy.
      */
     async function paste(text) {
-        await bus_1.bus.request("clipboard.paste", {
-            content: mapContent(text),
-        });
+        await (0, client_1.getClient)().Clipboard.paste(mapContent(text));
     }
     Clipboard.paste = paste;
     /**
@@ -60,9 +57,8 @@ var Clipboard;
      * const { text, html, file } = await Clipboard.read();
      * ```
      */
-    async function read(options) {
-        const res = await bus_1.bus.request("clipboard.readContent", {});
-        return res.unwrap().content;
+    async function read() {
+        return (0, client_1.getClient)().Clipboard.readContent();
     }
     Clipboard.read = read;
     /**
@@ -75,16 +71,15 @@ var Clipboard;
      * const text = await Clipboard.readText();
      * ```
      */
-    async function readText(options) {
-        const { text } = await read(options);
-        return text;
+    async function readText() {
+        return read().then((r) => r.text ?? "");
     }
     Clipboard.readText = readText;
     /**
      * Clear the current clipboard content.
      */
     async function clear() {
-        await bus_1.bus.request("clipboard.clear", {});
+        await (0, client_1.getClient)().Clipboard.clear();
     }
     Clipboard.clear = clear;
 })(Clipboard || (exports.Clipboard = Clipboard = {}));

package/dist/api/color.d.ts

@@ -1,14 +1,9 @@
-import * as ui from "./proto/ui";
-type DynamicColor = {
-    dark: string;
-    light: string;
-    adjustContrast?: boolean;
-};
+import type * as api from "./proto/api";
 /**
  * @category Colors
  */
 export declare namespace Color {
-    type Dynamic = DynamicColor;
+    type Dynamic = api.DynamicColor;
     type Raw = string;
 }
 /**
@@ -29,6 +24,5 @@ export declare enum Color {
  * @category Colors
  */
 export type ColorLike = Color.Dynamic | Color.Raw | Color;
-export type SerializedColorLike = ui.ColorLike;
-export declare const serializeColorLike: (color: ColorLike) => SerializedColorLike;
-export {};
+export type SerializedColorLike = api.ColorLike;
+export declare const serializeColorLike: (color: ColorLike) => api.ColorLike;

package/dist/api/color.js

@@ -1,40 +1,6 @@
 "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.serializeColorLike = exports.Color = void 0;
-const ui = __importStar(require("./proto/ui"));
 /**
  * @category Colors
  */
@@ -51,20 +17,15 @@ var Color;
     Color["SecondaryText"] = "secondary-text";
 })(Color || (exports.Color = Color = {}));
 const serializeColorLike = (color) => {
-    const colorLike = ui.ColorLike.create();
     if (typeof color === "string") {
-        colorLike.raw = color;
+        return { raw: color };
     }
-    else {
-        // It's a DynamicColor
-        const dynamicColor = ui.DynamicColor.create();
-        dynamicColor.light = color.light;
-        dynamicColor.dark = color.dark;
-        if (color.adjustContrast !== undefined) {
-            dynamicColor.adjustContrast = color.adjustContrast;
-        }
-        colorLike.dynamic = dynamicColor;
-    }
-    return colorLike;
+    return {
+        dynamic: {
+            light: color.light,
+            dark: color.dark,
+            adjustContrast: color.adjustContrast,
+        },
+    };
 };
 exports.serializeColorLike = serializeColorLike;

package/dist/api/command.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.updateCommandMetadata = updateCommandMetadata;
-const bus_1 = require("./bus");
+const client_1 = require("./client");
 /**
  * Update the values of properties declared in the manifest of the current command.
  * Currently only `subtitle` is supported. Pass `null` to clear the custom subtitle.
@@ -9,9 +9,7 @@ const bus_1 = require("./bus");
  * Raycast API: https://developers.raycast.com/api-reference/command#updatecommandmetadata
  */
 async function updateCommandMetadata(metadata) {
-    const payload = {};
-    if (Object.prototype.hasOwnProperty.call(metadata, "subtitle")) {
-        payload.subtitle = metadata.subtitle ?? undefined;
-    }
-    await bus_1.bus.request("command.updateCommandMetadata", payload);
+    await (0, client_1.getClient)().Command.updateCommandMetadata({
+        subtitle: metadata.subtitle ?? undefined,
+    });
 }

package/dist/api/controls.js

@@ -1,41 +1,7 @@
 "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.popToRoot = exports.getSelectedText = exports.clearSearchBar = exports.closeMainWindow = exports.showHUD = exports.PopToRootType = void 0;
-const bus_1 = require("./bus");
-const ui = __importStar(require("./proto/ui"));
+const client_1 = require("./client");
 /**
  * @category Launcher Window
  */
@@ -56,9 +22,9 @@ var PopToRootType;
     PopToRootType["Suspended"] = "suspended";
 })(PopToRootType || (exports.PopToRootType = PopToRootType = {}));
 const popToRootProtoMap = {
-    [PopToRootType.Default]: ui.PopToRootType.PopToRootDefault,
-    [PopToRootType.Immediate]: ui.PopToRootType.PopToRootImmediate,
-    [PopToRootType.Suspended]: ui.PopToRootType.PopToRootSuspended,
+    [PopToRootType.Default]: "Default",
+    [PopToRootType.Immediate]: "Immediate",
+    [PopToRootType.Suspended]: "Suspended",
 };
 /**
  * Close the window and show a small HUD where the window was previously opened.
@@ -71,11 +37,7 @@ const popToRootProtoMap = {
  * @category Launcher Window
  */
 const showHUD = async (title, options) => {
-    bus_1.bus.request("ui.showHud", {
-        text: title,
-        clearRootSearch: options?.clearRootSearch ?? false,
-        popToRoot: popToRootProtoMap[options?.popToRootType ?? PopToRootType.Default],
-    });
+    (0, client_1.getClient)().UI.showHud(title, options?.clearRootSearch ?? false, popToRootProtoMap[options?.popToRootType ?? PopToRootType.Default]);
 };
 exports.showHUD = showHUD;
 /**
@@ -86,17 +48,14 @@ exports.showHUD = showHUD;
  */
 const closeMainWindow = async (options = {}) => {
     const { clearRootSearch = false, popToRootType = PopToRootType.Default } = options;
-    await bus_1.bus.request("ui.closeMainWindow", {
-        clearRootSearch,
-        popToRoot: popToRootProtoMap[popToRootType],
-    });
+    await (0, client_1.getClient)().UI.closeMainWindow(clearRootSearch, popToRootProtoMap[popToRootType]);
 };
 exports.closeMainWindow = closeMainWindow;
 /**
  * @category Launcher Window
  */
 const clearSearchBar = async () => {
-    await bus_1.bus.request("ui.setSearchText", { text: "" });
+    await (0, client_1.getClient)().UI.setSearchText("");
 };
 exports.clearSearchBar = clearSearchBar;
 /**
@@ -107,11 +66,7 @@ exports.clearSearchBar = clearSearchBar;
  * @category Launcher Window
  */
 const getSelectedText = async () => {
-    const response = await bus_1.bus.request("ui.getSelectedText", {});
-    if (!response.ok) {
-        throw new Error(`Failed to get selected text`);
-    }
-    return response.value.text;
+    return (0, client_1.getClient)().UI.getSelectedText();
 };
 exports.getSelectedText = getSelectedText;
 /**
@@ -120,8 +75,6 @@ exports.getSelectedText = getSelectedText;
  * @category Launcher Window
  */
 const popToRoot = async (options) => {
-    await bus_1.bus.request("ui.popToRoot", {
-        clearSearchBar: options?.clearSearchBar ?? false,
-    });
+    await (0, client_1.getClient)().UI.popToRoot(options?.clearSearchBar ?? false);
 };
 exports.popToRoot = popToRoot;

package/dist/api/environment.d.ts

@@ -131,15 +131,4 @@ export interface Environment {
      */
     isRaycast: boolean;
 }
-/**
- * General information about the running extension command, the vicinae version, the capabilities of
- * the system we are running on, etc...
- *
- * @example
- * ```typescript
- * import { environment } from '@vicinae/api';
- *
- * console.log({ environment });
- * ```
- */
 export declare const environment: Environment;

package/dist/api/environment.js

@@ -23,4 +23,5 @@ var LaunchType;
  * console.log({ environment });
  * ```
  */
-exports.environment = globalThis.vicinae.environ;
+const globals_1 = require("./globals");
+exports.environment = (0, globals_1.getGlobal)().environ;

package/dist/api/file-search.d.ts

@@ -1,4 +1,4 @@
-import { FileInfo as ProtoFileInfo } from "./proto/file-search";
+import type * as api from "./proto/api";
 /**
  * Access Vicinae's built-in file search functionality.
  *
@@ -22,8 +22,7 @@ export declare namespace FileSearch {
     /**
      * For now we provide no options, but in the future we will implement mime type and file type filtering.
      * */
-    type SearchOptions = {};
-    type FileInfo = ProtoFileInfo;
+    type FileInfo = api.FileInfo;
     /**
      * Search for files matching the provided query string.
      *
@@ -42,5 +41,5 @@ export declare namespace FileSearch {
      * const files = await fileSearch.search('invoice');
      * ```
      */
-    function search(query: string, _?: FileSearch.SearchOptions): Promise<FileSearch.FileInfo[]>;
+    function search(query: string): Promise<FileSearch.FileInfo[]>;
 }

package/dist/api/file-search.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FileSearch = void 0;
-const bus_1 = require("./bus");
+const client_1 = require("./client");
 /**
  * Access Vicinae's built-in file search functionality.
  *
@@ -23,6 +23,9 @@ const bus_1 = require("./bus");
  */
 var FileSearch;
 (function (FileSearch) {
+    /**
+     * For now we provide no options, but in the future we will implement mime type and file type filtering.
+     * */
     /**
      * Search for files matching the provided query string.
      *
@@ -41,9 +44,8 @@ var FileSearch;
      * const files = await fileSearch.search('invoice');
      * ```
      */
-    async function search(query, _ = {}) {
-        const res = await bus_1.bus.request("fileSearch.search", { query });
-        return res.unwrap().files;
+    async function search(query) {
+        return (0, client_1.getClient)().FileSearch.search(query);
     }
     FileSearch.search = search;
 })(FileSearch || (exports.FileSearch = FileSearch = {}));

package/dist/api/globals.d.ts

@@ -0,0 +1,9 @@
+import type React from "react";
+import type { Environment } from "./environment";
+export interface VicinaGlobal {
+    client: any;
+    environ: Environment;
+    preferences: any;
+    navigationContext: React.Context<any>;
+}
+export declare const getGlobal: () => VicinaGlobal;

package/dist/api/globals.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getGlobal = void 0;
+const getGlobal = () => globalThis.vicinae;
+exports.getGlobal = getGlobal;

package/dist/api/hooks/use-imperative-form-handle.d.ts

@@ -1,3 +1,3 @@
+import { type Ref } from "react";
 import type { Form } from "../components/form";
-import type { Ref } from "react";
 export declare const useImperativeFormHandle: (ref?: Ref<Form.ItemReference>) => [string];

package/dist/api/hooks/use-imperative-form-handle.js

@@ -2,21 +2,24 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.useImperativeFormHandle = void 0;
 const react_1 = require("react");
-const bus_1 = require("../bus");
 const node_crypto_1 = require("node:crypto");
 const useImperativeFormHandle = (ref) => {
     const handleId = (0, react_1.useRef)((0, node_crypto_1.randomUUID)());
     (0, react_1.useImperativeHandle)(ref, () => {
         return {
             focus: () => {
-                bus_1.bus.emit(handleId.current, {
+                /*
+                bus.emit(handleId.current, {
                     type: "focus",
                 });
+                */
             },
             reset: () => {
-                bus_1.bus.emit(handleId.current, {
+                /*
+                bus.emit(handleId.current, {
                     type: "reset",
                 });
+                */
             },
         };
     }, []);

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

@@ -5,6 +5,6 @@
  * @category Navigation
  */
 export declare const useNavigation: () => {
-    push: (node: import("react").ReactNode) => void;
-    pop: () => void;
+    push: any;
+    pop: any;
 };

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

@@ -1,11 +1,8 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.useNavigation = void 0;
 const react_1 = require("react");
-const navigation_context_1 = __importDefault(require("../context/navigation-context"));
+const globals_1 = require("../globals");
 /**
  * A React hook that lets you access methods to push and pop views
  * on the navigation stack.
@@ -13,7 +10,7 @@ const navigation_context_1 = __importDefault(require("../context/navigation-cont
  * @category Navigation
  */
 const useNavigation = () => {
-    const { push, pop } = (0, react_1.useContext)(navigation_context_1.default);
+    const { push, pop } = (0, react_1.useContext)((0, globals_1.getGlobal)().navigationContext);
     return { push, pop };
 };
 exports.useNavigation = useNavigation;

package/dist/api/image.d.ts

@@ -1,6 +1,6 @@
 import { type ColorLike } from "./color";
-import type { Icon } from "./icon";
-import * as ui from "./proto/ui";
+import { Icon } from "./icon";
+import type * as api from "./proto/api";
 /**
  * Representation of an image, renderable everywhere Vicine expects them.
  * @category Image
@@ -15,7 +15,7 @@ export type Image = {
  * @category Image
  */
 export type ImageLike = Image.ImageLike;
-export type SerializedImageLike = URL | Image.Asset | Icon | ui.Image | Image.ThemedImage;
+export type SerializedImageLike = URL | Image.Asset | Icon | api.Image | Image.ThemedImage;
 /**
  * @category Image
  */
@@ -37,4 +37,4 @@ export declare namespace Image {
         RoundedRectangle = "roundedRectangle"
     }
 }
-export declare const serializeProtoImage: (image: ImageLike) => ui.Image;
+export declare const serializeProtoImage: (image: ImageLike) => api.Image;