@vicinae/api 0.12.2 → 0.13.0

package/dist/api/components/grid.d.ts

@@ -21,11 +21,12 @@ export declare namespace Grid {
     namespace Section {
         type Props = GridSectionProps;
     }
+    type Fit = GridFit;
     type Props = GridProps;
     type Inset = GridInset;
     type AspectRatio = GridAspectRatio;
     namespace Item {
-        type Props = {
+        export type Props = {
             title?: string;
             detail?: React.ReactNode;
             keywords?: string[];
@@ -49,7 +50,7 @@ export declare namespace Grid {
             color: Color;
             value: string | Date | undefined | null;
         };
-        type Accessory = ({
+        export type Accessory = ({
             tag?: Tag;
         } | {
             text?: Text;
@@ -57,6 +58,7 @@ export declare namespace Grid {
             icon?: Image.ImageLike;
             tooltip?: string | null;
         };
+        export {};
     }
 }
 type GridProps = SectionConfig & {
@@ -109,6 +111,7 @@ export declare const Grid: React.FC<GridProps> & {
             children?: ReactNode;
         }>;
     };
+    Fit: typeof GridFit;
     Inset: typeof GridInset;
     Item: React.FC<Grid.Item.Props> & {
         Accessory: React.FC<Grid.Item.Accessory>;

package/dist/api/components/grid.js

@@ -13,6 +13,15 @@ var GridInset;
     GridInset["Medium"] = "medium";
     GridInset["Large"] = "large";
 })(GridInset || (GridInset = {}));
+const aspectRatioMap = {
+    '1': 1,
+    '3/2': 3 / 2,
+    '2/3': 2 / 3,
+    '4/3': 4 / 3,
+    '3/4': 3 / 4,
+    '16/9': 16 / 9,
+    '9/16': 9 / 16
+};
 var GridFit;
 (function (GridFit) {
     GridFit["Contain"] = "contain";
@@ -23,7 +32,7 @@ const GridRoot = ({ searchBarAccessory, children, actions, inset, fit = GridFit.
         typeof props.filtering === "undefined") {
         props.filtering = props.enableFiltering;
     }
-    return ((0, jsx_runtime_1.jsxs)("grid", { fit: fit, inset: inset, aspectRatio: aspectRatio, ...props, children: [searchBarAccessory, children, actions] }));
+    return ((0, jsx_runtime_1.jsxs)("grid", { fit: fit, inset: inset, aspectRatio: aspectRatioMap[aspectRatio], ...props, children: [searchBarAccessory, children, actions] }));
 };
 const GridItem = ({ detail, actions, keywords, ...props }) => {
     const id = (0, react_1.useRef)(props.id ?? (0, crypto_1.randomUUID)());
@@ -53,10 +62,10 @@ const GridItem = ({ detail, actions, keywords, ...props }) => {
     }
     return ((0, jsx_runtime_1.jsxs)("grid-item", { ...nativeProps, children: [detail, actions] }));
 };
-const GridSection = ({ fit = GridFit.Contain, aspectRatio = "1", inset, ...props }) => {
+const GridSection = ({ fit, aspectRatio, inset, ...props }) => {
     const nativeProps = {
         fit,
-        aspectRatio,
+        aspectRatio: aspectRatio ? aspectRatioMap[aspectRatio] : aspectRatio,
         inset,
         ...props,
     };
@@ -70,6 +79,7 @@ exports.Grid = Object.assign(GridRoot, {
     Section: GridSection,
     EmptyView: empty_view_1.EmptyView,
     Dropdown: dropdown_1.Dropdown,
+    Fit: GridFit,
     Inset: GridInset,
     Item: Object.assign(GridItem, {
         Accessory: exports.GridAccessory,

package/dist/api/controls.d.ts

@@ -1,6 +1,48 @@
-export declare const closeMainWindow: () => Promise<void>;
+export declare enum PopToRootType {
+    /**
+     * Translates to Immediate or Suspended depending on the
+     * user configuration.
+     */
+    Default = "default",
+    /**
+     * Immediately pop to root
+     */
+    Immediate = "immediate",
+    /**
+     * Do not pop to root, preserve the navigation state as it is
+     */
+    Suspended = "suspended"
+}
+/**
+ * Close the window and show a small HUD where the window was previously opened.
+ * Note that the HUD may not be shown in some environments.
+ * Similarly to `closeWindow`, it is possible to override the pop to root behavior directly
+ * by passing options to this function.
+ *
+ * @see closeWindow
+ */
+export declare const showHUD: (title: string, options?: {
+    clearRootSearch?: boolean;
+    popToRootType?: PopToRootType;
+}) => Promise<void>;
+/**
+ * Close the vicinae launcher window immediately.
+ * It is possible to override the `popToRoot` behavior defined in the settings using the options object.
+ */
+export declare const closeMainWindow: (options?: {
+    clearRootSearch?: boolean;
+    popToRootType?: PopToRootType;
+}) => Promise<void>;
 export declare const clearSearchBar: () => Promise<void>;
+/**
+ * Get the text that is currently selected by the user.
+ * How this is implemented depends on the environment but all it does is usually
+ * read the clipboard's primary selection buffer.
+ */
 export declare const getSelectedText: () => Promise<string>;
+/**
+ * Pop to the root of the navigation stack, optionally clearing the search bar.
+ */
 export declare const popToRoot: (options?: {
     clearSearchBar?: boolean;
 }) => Promise<void>;

package/dist/api/controls.js

@@ -1,15 +1,99 @@
 "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 = void 0;
+exports.popToRoot = exports.getSelectedText = exports.clearSearchBar = exports.closeMainWindow = exports.showHUD = exports.PopToRootType = void 0;
 const bus_1 = require("./bus");
-const closeMainWindow = async () => {
-    await bus_1.bus.turboRequest("ui.closeMainWindow", {});
+const ui = __importStar(require("./proto/ui"));
+var PopToRootType;
+(function (PopToRootType) {
+    /**
+     * Translates to Immediate or Suspended depending on the
+     * user configuration.
+     */
+    PopToRootType["Default"] = "default";
+    /**
+     * Immediately pop to root
+     */
+    PopToRootType["Immediate"] = "immediate";
+    /**
+     * Do not pop to root, preserve the navigation state as it is
+     */
+    PopToRootType["Suspended"] = "suspended";
+})(PopToRootType || (exports.PopToRootType = PopToRootType = {}));
+const popToRootProtoMap = {
+    [PopToRootType.Default]: ui.PopToRootType.PopToRootDefault,
+    [PopToRootType.Immediate]: ui.PopToRootType.PopToRootImmediate,
+    [PopToRootType.Suspended]: ui.PopToRootType.PopToRootSuspended,
+};
+/**
+ * Close the window and show a small HUD where the window was previously opened.
+ * Note that the HUD may not be shown in some environments.
+ * Similarly to `closeWindow`, it is possible to override the pop to root behavior directly
+ * by passing options to this function.
+ *
+ * @see closeWindow
+ */
+const showHUD = async (title, options) => {
+    bus_1.bus.turboRequest('ui.showHud', {
+        text: title,
+        clearRootSearch: options?.clearRootSearch ?? false,
+        popToRoot: popToRootProtoMap[options?.popToRootType ?? PopToRootType.Default]
+    });
+};
+exports.showHUD = showHUD;
+/**
+ * Close the vicinae launcher window immediately.
+ * It is possible to override the `popToRoot` behavior defined in the settings using the options object.
+ */
+const closeMainWindow = async (options = {}) => {
+    const { clearRootSearch = false, popToRootType = PopToRootType.Default } = options;
+    await bus_1.bus.turboRequest("ui.closeMainWindow", {
+        clearRootSearch,
+        popToRoot: popToRootProtoMap[popToRootType]
+    });
 };
 exports.closeMainWindow = closeMainWindow;
 const clearSearchBar = async () => {
     await bus_1.bus.turboRequest("ui.setSearchText", { text: "" });
 };
 exports.clearSearchBar = clearSearchBar;
+/**
+ * Get the text that is currently selected by the user.
+ * How this is implemented depends on the environment but all it does is usually
+ * read the clipboard's primary selection buffer.
+ */
 const getSelectedText = async () => {
     const response = await bus_1.bus.turboRequest("ui.getSelectedText", {});
     if (!response.ok) {
@@ -18,6 +102,9 @@ const getSelectedText = async () => {
     return response.value.text;
 };
 exports.getSelectedText = getSelectedText;
+/**
+ * Pop to the root of the navigation stack, optionally clearing the search bar.
+ */
 const popToRoot = async (options) => {
     await bus_1.bus.turboRequest('ui.popToRoot', { clearSearchBar: options?.clearSearchBar ?? false });
 };

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

@@ -29,7 +29,7 @@ export interface ResponseData {
 export interface ManagerLoadCommand {
     mode: CommandMode;
     env: CommandEnv;
-    extensionPath: string;
+    vicinaePath: string;
     /** javascript source file to execute */
     entrypoint: string;
     preferenceValues: {
@@ -40,6 +40,7 @@ export interface ManagerLoadCommand {
     };
     isRaycast: boolean;
     commandName: string;
+    extensionId: string;
 }
 export interface ManagerLoadCommand_PreferenceValuesEntry {
     key: string;

package/dist/api/proto/manager.js

@@ -277,12 +277,13 @@ function createBaseManagerLoadCommand() {
     return {
         mode: 0,
         env: 0,
-        extensionPath: "",
+        vicinaePath: "",
         entrypoint: "",
         preferenceValues: {},
         argumentValues: {},
         isRaycast: false,
         commandName: "",
+        extensionId: "",
     };
 }
 exports.ManagerLoadCommand = {
@@ -293,8 +294,8 @@ exports.ManagerLoadCommand = {
         if (message.env !== 0) {
             writer.uint32(16).int32(message.env);
         }
-        if (message.extensionPath !== "") {
-            writer.uint32(26).string(message.extensionPath);
+        if (message.vicinaePath !== "") {
+            writer.uint32(26).string(message.vicinaePath);
         }
         if (message.entrypoint !== "") {
             writer.uint32(34).string(message.entrypoint);
@@ -315,6 +316,9 @@ exports.ManagerLoadCommand = {
         if (message.commandName !== "") {
             writer.uint32(66).string(message.commandName);
         }
+        if (message.extensionId !== "") {
+            writer.uint32(74).string(message.extensionId);
+        }
         return writer;
     },
     decode(input, length) {
@@ -342,7 +346,7 @@ exports.ManagerLoadCommand = {
                     if (tag !== 26) {
                         break;
                     }
-                    message.extensionPath = reader.string();
+                    message.vicinaePath = reader.string();
                     continue;
                 }
                 case 4: {
@@ -386,6 +390,13 @@ exports.ManagerLoadCommand = {
                     message.commandName = reader.string();
                     continue;
                 }
+                case 9: {
+                    if (tag !== 74) {
+                        break;
+                    }
+                    message.extensionId = reader.string();
+                    continue;
+                }
             }
             if ((tag & 7) === 4 || tag === 0) {
                 break;
@@ -398,7 +409,7 @@ exports.ManagerLoadCommand = {
         return {
             mode: isSet(object.mode) ? commandModeFromJSON(object.mode) : 0,
             env: isSet(object.env) ? commandEnvFromJSON(object.env) : 0,
-            extensionPath: isSet(object.extensionPath) ? globalThis.String(object.extensionPath) : "",
+            vicinaePath: isSet(object.vicinaePath) ? globalThis.String(object.vicinaePath) : "",
             entrypoint: isSet(object.entrypoint) ? globalThis.String(object.entrypoint) : "",
             preferenceValues: isObject(object.preferenceValues)
                 ? Object.entries(object.preferenceValues).reduce((acc, [key, value]) => {
@@ -414,6 +425,7 @@ exports.ManagerLoadCommand = {
                 : {},
             isRaycast: isSet(object.isRaycast) ? globalThis.Boolean(object.isRaycast) : false,
             commandName: isSet(object.commandName) ? globalThis.String(object.commandName) : "",
+            extensionId: isSet(object.extensionId) ? globalThis.String(object.extensionId) : "",
         };
     },
     toJSON(message) {
@@ -424,8 +436,8 @@ exports.ManagerLoadCommand = {
         if (message.env !== 0) {
             obj.env = commandEnvToJSON(message.env);
         }
-        if (message.extensionPath !== "") {
-            obj.extensionPath = message.extensionPath;
+        if (message.vicinaePath !== "") {
+            obj.vicinaePath = message.vicinaePath;
         }
         if (message.entrypoint !== "") {
             obj.entrypoint = message.entrypoint;
@@ -454,6 +466,9 @@ exports.ManagerLoadCommand = {
         if (message.commandName !== "") {
             obj.commandName = message.commandName;
         }
+        if (message.extensionId !== "") {
+            obj.extensionId = message.extensionId;
+        }
         return obj;
     },
     create(base) {
@@ -463,7 +478,7 @@ exports.ManagerLoadCommand = {
         const message = createBaseManagerLoadCommand();
         message.mode = object.mode ?? 0;
         message.env = object.env ?? 0;
-        message.extensionPath = object.extensionPath ?? "";
+        message.vicinaePath = object.vicinaePath ?? "";
         message.entrypoint = object.entrypoint ?? "";
         message.preferenceValues = Object.entries(object.preferenceValues ?? {}).reduce((acc, [key, value]) => {
             if (value !== undefined) {
@@ -479,6 +494,7 @@ exports.ManagerLoadCommand = {
         }, {});
         message.isRaycast = object.isRaycast ?? false;
         message.commandName = object.commandName ?? "";
+        message.extensionId = object.extensionId ?? "";
         return message;
     },
 };

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

@@ -52,6 +52,8 @@ export interface PushViewRequest {
 export interface PopViewRequest {
 }
 export interface CloseMainWindowRequest {
+    clearRootSearch: boolean;
+    popToRoot: PopToRootType;
 }
 export interface ClearSearchBarRequest {
 }

package/dist/api/proto/ui.js

@@ -456,10 +456,16 @@ exports.PopViewRequest = {
     },
 };
 function createBaseCloseMainWindowRequest() {
-    return {};
+    return { clearRootSearch: false, popToRoot: 0 };
 }
 exports.CloseMainWindowRequest = {
-    encode(_, writer = new wire_1.BinaryWriter()) {
+    encode(message, writer = new wire_1.BinaryWriter()) {
+        if (message.clearRootSearch !== false) {
+            writer.uint32(8).bool(message.clearRootSearch);
+        }
+        if (message.popToRoot !== 0) {
+            writer.uint32(16).int32(message.popToRoot);
+        }
         return writer;
     },
     decode(input, length) {
@@ -469,6 +475,20 @@ exports.CloseMainWindowRequest = {
         while (reader.pos < end) {
             const tag = reader.uint32();
             switch (tag >>> 3) {
+                case 1: {
+                    if (tag !== 8) {
+                        break;
+                    }
+                    message.clearRootSearch = reader.bool();
+                    continue;
+                }
+                case 2: {
+                    if (tag !== 16) {
+                        break;
+                    }
+                    message.popToRoot = reader.int32();
+                    continue;
+                }
             }
             if ((tag & 7) === 4 || tag === 0) {
                 break;
@@ -477,18 +497,29 @@ exports.CloseMainWindowRequest = {
         }
         return message;
     },
-    fromJSON(_) {
-        return {};
+    fromJSON(object) {
+        return {
+            clearRootSearch: isSet(object.clearRootSearch) ? globalThis.Boolean(object.clearRootSearch) : false,
+            popToRoot: isSet(object.popToRoot) ? popToRootTypeFromJSON(object.popToRoot) : 0,
+        };
     },
-    toJSON(_) {
+    toJSON(message) {
         const obj = {};
+        if (message.clearRootSearch !== false) {
+            obj.clearRootSearch = message.clearRootSearch;
+        }
+        if (message.popToRoot !== 0) {
+            obj.popToRoot = popToRootTypeToJSON(message.popToRoot);
+        }
         return obj;
     },
     create(base) {
         return exports.CloseMainWindowRequest.fromPartial(base ?? {});
     },
-    fromPartial(_) {
+    fromPartial(object) {
         const message = createBaseCloseMainWindowRequest();
+        message.clearRootSearch = object.clearRootSearch ?? false;
+        message.popToRoot = object.popToRoot ?? 0;
         return message;
     },
 };

package/dist/api/toast.d.ts

@@ -157,12 +157,3 @@ export declare interface ToastOptions extends Toast.Options {
  */
 export declare const ToastStyle: typeof Toast.Style;
 export declare const showToast: (init: Toast.Style | Toast.Options, title?: string, message?: string) => Promise<Toast>;
-export declare enum PopToRootType {
-    Default = "default",
-    Immediate = "immediate",
-    Suspended = "suspended"
-}
-export declare const showHUD: (title: string, options?: {
-    clearRootSearch?: boolean;
-    popToRootType?: PopToRootType;
-}) => Promise<void>;

package/dist/api/toast.js

@@ -33,7 +33,7 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.showHUD = exports.PopToRootType = exports.showToast = exports.Toast = void 0;
+exports.showToast = exports.Toast = void 0;
 const crypto_1 = require("crypto");
 const bus_1 = require("./bus");
 const ui = __importStar(require("./proto/ui"));
@@ -200,22 +200,3 @@ const showToast = async (init, title = "", message) => {
     return toast;
 };
 exports.showToast = showToast;
-var PopToRootType;
-(function (PopToRootType) {
-    PopToRootType["Default"] = "default";
-    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) => {
-    bus_1.bus.turboRequest('ui.showHud', {
-        text: title,
-        clearRootSearch: options?.clearRootSearch ?? false,
-        popToRoot: popToRootProtoMap[options?.popToRootType ?? PopToRootType.Default]
-    });
-};
-exports.showHUD = showHUD;

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "@vicinae/api",
-  "version": "0.12.2",
+  "version": "0.13.0",
   "description": "TypeScript SDK to build Vicinae extensions",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
     "build": "tsc --outDir dist",
+    "protogen": "mkdir ./src/api/proto && protoc --plugin=./node_modules/.bin/protoc-gen-ts_proto -I../proto ../proto/*.proto --ts_proto_out ./src/api/proto",
     "pack": "npm run build && npm pack",
     "docgen-html": "typedoc src/api/index.ts",
-    "docgen-md": "typedoc src/api/index.ts --readme none --plugin typedoc-plugin-markdown --out ./docs"
+    "docgen-md": "typedoc src/api/index.ts --disableSources --readme none --plugin typedoc-plugin-markdown --out ./docs"
   },
   "bin": {
     "vici": "./bin/run.js"

package/types/jsx.d.ts

@@ -65,8 +65,8 @@ declare module "react" {
       "grid-section": {
         inset?: Grid.Inset;
         columns?: number;
-        fit: Grid.Fit;
-        aspectRatio: Grid.AspectRatio;
+        fit?: Grid.Fit;
+        aspectRatio?: Grid.AspectRatio;
 
         title?: string;
         subtitle?: string;