@vicinae/api 0.20.3 → 0.20.5

package/dist/api/bus.d.ts

@@ -42,6 +42,7 @@ type EndpointMapping = {
     "app.open": "app.open";
     "app.getDefault": "app.getDefault";
     "app.runInTerminal": "app.runInTerminal";
+    "app.showInFileBrowser": "app.showInFileBrowser";
     "ui.render": "ui.render";
     "ui.showToast": "ui.showToast";
     "ui.hideToast": "ui.hideToast";

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

@@ -65,6 +65,7 @@ export declare namespace Action {
             path: PathLike;
             icon?: ImageLike;
             onShow?: (path: PathLike) => void;
+            select?: boolean;
             shortcut?: Keyboard.Shortcut;
             title?: string;
         };

package/dist/api/components/actions.js

@@ -43,9 +43,10 @@ const OpenInBrowser = ({ url, title = "Open in Browser", ...props }) => {
             await (0, controls_1.closeMainWindow)();
         } }));
 };
-const ShowInFinder = ({ path, title = "Show in Finder", ...props }) => {
+const ShowInFinder = ({ path, select = true, title = "Show in file browser", ...props }) => {
     return ((0, jsx_runtime_1.jsx)(ActionRoot, { ...props, title: title, onAction: () => {
-            (0, utils_1.showInFileBrowser)(path);
+            (0, utils_1.showInFileBrowser)(path, { select });
+            (0, controls_1.closeMainWindow)();
         } }));
 };
 const Push = ({ target, ...props }) => {

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

@@ -24,17 +24,23 @@ export interface GetDefaultApplicationRequest {
 export interface GetDefaultApplicationResponse {
     app: Application | undefined;
 }
+export interface ShowInFileBrowserRequest {
+    target: string;
+    select: boolean;
+}
 export interface Request {
     list?: ListApplicationRequest | undefined;
     open?: OpenApplicationRequest | undefined;
     getDefault?: GetDefaultApplicationRequest | undefined;
     runInTerminal?: RunInTerminalRequest | undefined;
+    showInFileBrowser?: ShowInFileBrowserRequest | undefined;
 }
 export interface Response {
     list?: ListApplicationResponse | undefined;
     open?: AckResponse | undefined;
     getDefault?: GetDefaultApplicationResponse | undefined;
     runInTerminal?: AckResponse | undefined;
+    showInFileBrowser?: AckResponse | undefined;
 }
 export interface Application {
     id: string;
@@ -48,6 +54,7 @@ export declare const ListApplicationRequest: MessageFns<ListApplicationRequest>;
 export declare const ListApplicationResponse: MessageFns<ListApplicationResponse>;
 export declare const GetDefaultApplicationRequest: MessageFns<GetDefaultApplicationRequest>;
 export declare const GetDefaultApplicationResponse: MessageFns<GetDefaultApplicationResponse>;
+export declare const ShowInFileBrowserRequest: MessageFns<ShowInFileBrowserRequest>;
 export declare const Request: MessageFns<Request>;
 export declare const Response: MessageFns<Response>;
 export declare const Application: MessageFns<Application>;

package/dist/api/proto/application.js

@@ -5,7 +5,7 @@
 //   protoc               v6.33.1
 // source: application.proto
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Application = exports.Response = exports.Request = exports.GetDefaultApplicationResponse = exports.GetDefaultApplicationRequest = exports.ListApplicationResponse = exports.ListApplicationRequest = exports.RunInTerminalRequest = exports.OpenApplicationRequest = exports.protobufPackage = void 0;
+exports.Application = exports.Response = exports.Request = exports.ShowInFileBrowserRequest = exports.GetDefaultApplicationResponse = exports.GetDefaultApplicationRequest = exports.ListApplicationResponse = exports.ListApplicationRequest = exports.RunInTerminalRequest = exports.OpenApplicationRequest = exports.protobufPackage = void 0;
 /* eslint-disable */
 const wire_1 = require("@bufbuild/protobuf/wire");
 const common_1 = require("./common");
@@ -395,8 +395,82 @@ exports.GetDefaultApplicationResponse = {
         return message;
     },
 };
+function createBaseShowInFileBrowserRequest() {
+    return { target: "", select: false };
+}
+exports.ShowInFileBrowserRequest = {
+    encode(message, writer = new wire_1.BinaryWriter()) {
+        if (message.target !== "") {
+            writer.uint32(10).string(message.target);
+        }
+        if (message.select !== false) {
+            writer.uint32(16).bool(message.select);
+        }
+        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 = createBaseShowInFileBrowserRequest();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1: {
+                    if (tag !== 10) {
+                        break;
+                    }
+                    message.target = reader.string();
+                    continue;
+                }
+                case 2: {
+                    if (tag !== 16) {
+                        break;
+                    }
+                    message.select = reader.bool();
+                    continue;
+                }
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skip(tag & 7);
+        }
+        return message;
+    },
+    fromJSON(object) {
+        return {
+            target: isSet(object.target) ? globalThis.String(object.target) : "",
+            select: isSet(object.select) ? globalThis.Boolean(object.select) : false,
+        };
+    },
+    toJSON(message) {
+        const obj = {};
+        if (message.target !== "") {
+            obj.target = message.target;
+        }
+        if (message.select !== false) {
+            obj.select = message.select;
+        }
+        return obj;
+    },
+    create(base) {
+        return exports.ShowInFileBrowserRequest.fromPartial(base ?? {});
+    },
+    fromPartial(object) {
+        const message = createBaseShowInFileBrowserRequest();
+        message.target = object.target ?? "";
+        message.select = object.select ?? false;
+        return message;
+    },
+};
 function createBaseRequest() {
-    return { list: undefined, open: undefined, getDefault: undefined, runInTerminal: undefined };
+    return {
+        list: undefined,
+        open: undefined,
+        getDefault: undefined,
+        runInTerminal: undefined,
+        showInFileBrowser: undefined,
+    };
 }
 exports.Request = {
     encode(message, writer = new wire_1.BinaryWriter()) {
@@ -412,6 +486,9 @@ exports.Request = {
         if (message.runInTerminal !== undefined) {
             exports.RunInTerminalRequest.encode(message.runInTerminal, writer.uint32(34).fork()).join();
         }
+        if (message.showInFileBrowser !== undefined) {
+            exports.ShowInFileBrowserRequest.encode(message.showInFileBrowser, writer.uint32(42).fork()).join();
+        }
         return writer;
     },
     decode(input, length) {
@@ -449,6 +526,13 @@ exports.Request = {
                     message.runInTerminal = exports.RunInTerminalRequest.decode(reader, reader.uint32());
                     continue;
                 }
+                case 5: {
+                    if (tag !== 42) {
+                        break;
+                    }
+                    message.showInFileBrowser = exports.ShowInFileBrowserRequest.decode(reader, reader.uint32());
+                    continue;
+                }
             }
             if ((tag & 7) === 4 || tag === 0) {
                 break;
@@ -463,6 +547,9 @@ exports.Request = {
             open: isSet(object.open) ? exports.OpenApplicationRequest.fromJSON(object.open) : undefined,
             getDefault: isSet(object.getDefault) ? exports.GetDefaultApplicationRequest.fromJSON(object.getDefault) : undefined,
             runInTerminal: isSet(object.runInTerminal) ? exports.RunInTerminalRequest.fromJSON(object.runInTerminal) : undefined,
+            showInFileBrowser: isSet(object.showInFileBrowser)
+                ? exports.ShowInFileBrowserRequest.fromJSON(object.showInFileBrowser)
+                : undefined,
         };
     },
     toJSON(message) {
@@ -479,6 +566,9 @@ exports.Request = {
         if (message.runInTerminal !== undefined) {
             obj.runInTerminal = exports.RunInTerminalRequest.toJSON(message.runInTerminal);
         }
+        if (message.showInFileBrowser !== undefined) {
+            obj.showInFileBrowser = exports.ShowInFileBrowserRequest.toJSON(message.showInFileBrowser);
+        }
         return obj;
     },
     create(base) {
@@ -498,11 +588,20 @@ exports.Request = {
         message.runInTerminal = (object.runInTerminal !== undefined && object.runInTerminal !== null)
             ? exports.RunInTerminalRequest.fromPartial(object.runInTerminal)
             : undefined;
+        message.showInFileBrowser = (object.showInFileBrowser !== undefined && object.showInFileBrowser !== null)
+            ? exports.ShowInFileBrowserRequest.fromPartial(object.showInFileBrowser)
+            : undefined;
         return message;
     },
 };
 function createBaseResponse() {
-    return { list: undefined, open: undefined, getDefault: undefined, runInTerminal: undefined };
+    return {
+        list: undefined,
+        open: undefined,
+        getDefault: undefined,
+        runInTerminal: undefined,
+        showInFileBrowser: undefined,
+    };
 }
 exports.Response = {
     encode(message, writer = new wire_1.BinaryWriter()) {
@@ -518,6 +617,9 @@ exports.Response = {
         if (message.runInTerminal !== undefined) {
             common_1.AckResponse.encode(message.runInTerminal, writer.uint32(34).fork()).join();
         }
+        if (message.showInFileBrowser !== undefined) {
+            common_1.AckResponse.encode(message.showInFileBrowser, writer.uint32(42).fork()).join();
+        }
         return writer;
     },
     decode(input, length) {
@@ -555,6 +657,13 @@ exports.Response = {
                     message.runInTerminal = common_1.AckResponse.decode(reader, reader.uint32());
                     continue;
                 }
+                case 5: {
+                    if (tag !== 42) {
+                        break;
+                    }
+                    message.showInFileBrowser = common_1.AckResponse.decode(reader, reader.uint32());
+                    continue;
+                }
             }
             if ((tag & 7) === 4 || tag === 0) {
                 break;
@@ -569,6 +678,7 @@ exports.Response = {
             open: isSet(object.open) ? common_1.AckResponse.fromJSON(object.open) : undefined,
             getDefault: isSet(object.getDefault) ? exports.GetDefaultApplicationResponse.fromJSON(object.getDefault) : undefined,
             runInTerminal: isSet(object.runInTerminal) ? common_1.AckResponse.fromJSON(object.runInTerminal) : undefined,
+            showInFileBrowser: isSet(object.showInFileBrowser) ? common_1.AckResponse.fromJSON(object.showInFileBrowser) : undefined,
         };
     },
     toJSON(message) {
@@ -585,6 +695,9 @@ exports.Response = {
         if (message.runInTerminal !== undefined) {
             obj.runInTerminal = common_1.AckResponse.toJSON(message.runInTerminal);
         }
+        if (message.showInFileBrowser !== undefined) {
+            obj.showInFileBrowser = common_1.AckResponse.toJSON(message.showInFileBrowser);
+        }
         return obj;
     },
     create(base) {
@@ -604,6 +717,9 @@ exports.Response = {
         message.runInTerminal = (object.runInTerminal !== undefined && object.runInTerminal !== null)
             ? common_1.AckResponse.fromPartial(object.runInTerminal)
             : undefined;
+        message.showInFileBrowser = (object.showInFileBrowser !== undefined && object.showInFileBrowser !== null)
+            ? common_1.AckResponse.fromPartial(object.showInFileBrowser)
+            : undefined;
         return message;
     },
 };

package/dist/api/utils.d.ts

@@ -35,6 +35,15 @@ export type RunInTerminalOptions = {
      */
     title?: string;
 };
+/**
+ * @category System
+ */
+export type ShowInFileBrowserOptions = {
+    /**
+     * Reveal the item selected in its containing folder instead of just opening the target path.
+     */
+    select?: boolean;
+};
 /**
  * Run a command in a new terminal emulator window.
  *
@@ -70,5 +79,5 @@ export declare const getDefaultApplication: (path: string) => Promise<Applicatio
 /**
  * @category System
  */
-export declare const showInFileBrowser: (path: PathLike) => Promise<void>;
+export declare const showInFileBrowser: (path: PathLike, options?: ShowInFileBrowserOptions) => Promise<void>;
 export { Application } from "./proto/application";

package/dist/api/utils.js

@@ -90,7 +90,14 @@ exports.getDefaultApplication = getDefaultApplication;
 /**
  * @category System
  */
-const showInFileBrowser = async (path) => {
+const showInFileBrowser = async (path, options = {}) => {
+    if (options.select) {
+        await bus_1.bus.request("app.showInFileBrowser", {
+            target: path.toString(),
+            select: true,
+        });
+        return;
+    }
     const fileBrowser = await (0, exports.getDefaultApplication)("inode/directory"); // FIXME: we may want something more robust
     await (0, exports.open)(path.toString(), fileBrowser);
 };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@vicinae/api",
-	"version": "0.20.3",
+	"version": "0.20.5",
 	"description": "TypeScript SDK to build Vicinae extensions",
 	"scripts": {
 		"test": "echo \"Error: no test specified\" && exit 1",
@@ -50,7 +50,7 @@
 		"@types/chai": "^4",
 		"@types/mocha": "^10",
 		"chai": "^4",
-		"mocha": "^10",
+		"mocha": "^11.7.5",
 		"oclif": "^4",
 		"shx": "^0.3.3",
 		"ts-node": "^10",