@vicinae/api 0.11.0 → 0.12.1

package/README.md

@@ -7,7 +7,7 @@ This package lets you extend the [Vicinae](https://docs.vicinae.com/) launcher u
 
 The recommend way to start developing a new extension is to [read the docs](https://docs.vicinae.com/extensions/introduction).
 
-You can stop reading this.
+The full API reference (expect breaking changes) can be found [here](./docs/README.md).
 
 # Installation 
 
@@ -32,15 +32,6 @@ npx vici --help
 
 # assuming vicinae is running
 npx vici develop
-npx vici build -o my/output/path
-```
-
-# API developers
-
-If you are working on developing the API, it is recommended to point `@vicinae/api` to the local api directory:
 
+npx vici build -o my/output/path
 ```
-npm install /path/to/vicinae/source/api
-```
-
-Note that you need to recompile the `api` package on every change you make to it.

package/dist/api/clipboard.d.ts

@@ -1,5 +1,4 @@
 import { PathLike } from "fs";
-import { ClipboardContent } from "./proto/clipboard";
 export declare namespace Clipboard {
     type Content = {
         text: string;
@@ -19,16 +18,13 @@ export declare namespace Clipboard {
     type CopyOptions = {
         concealed?: boolean;
     };
-}
-export declare const Clipboard: {
-    mapContent(content: string | number | Clipboard.Content): ClipboardContent;
-    copy(text: string | number | Clipboard.Content, options?: Clipboard.CopyOptions): Promise<void>;
-    paste(text: string | Clipboard.Content): Promise<void>;
-    read(options?: {
+    function copy(text: string | number | Clipboard.Content, options?: Clipboard.CopyOptions): Promise<void>;
+    function paste(text: string | Clipboard.Content): Promise<void>;
+    function read(options?: {
         offset?: number;
     }): Promise<Clipboard.ReadContent>;
-    readText(options?: {
+    function readText(options?: {
         offset?: number;
     }): Promise<string | undefined>;
-    clear(text: string): Promise<never>;
-};
+    function clear(text: string): Promise<void>;
+}

package/dist/api/clipboard.js

@@ -3,8 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Clipboard = void 0;
 const bus_1 = require("./bus");
 const clipboard_1 = require("./proto/clipboard");
-exports.Clipboard = {
-    mapContent(content) {
+var Clipboard;
+(function (Clipboard) {
+    function mapContent(content) {
         let ct = clipboard_1.ClipboardContent.create();
         if (typeof content != "object") {
             ct.text = `${content}`;
@@ -21,25 +22,30 @@ exports.Clipboard = {
             }
         }
         return ct;
-    },
-    async copy(text, options = {}) {
+    }
+    async function copy(text, options = {}) {
         await bus_1.bus.turboRequest("clipboard.copy", {
-            content: this.mapContent(text),
+            content: mapContent(text),
             options: { concealed: options.concealed ?? false },
         });
-    },
-    async paste(text) {
+    }
+    Clipboard.copy = copy;
+    async function paste(text) {
         await bus_1.bus.turboRequest("clipboard.paste", {
-            content: this.mapContent(text),
+            content: mapContent(text),
         });
-    },
-    async read(options) {
+    }
+    Clipboard.paste = paste;
+    async function read(options) {
         throw new Error('Clipboard.read not implemented');
-    },
-    async readText(options) {
+    }
+    Clipboard.read = read;
+    async function readText(options) {
         throw new Error('Clipboard.readText not implemented');
-    },
-    async clear(text) {
+    }
+    Clipboard.readText = readText;
+    async function clear(text) {
         throw new Error('Clibpoard.clear not implemented');
-    },
-};
+    }
+    Clipboard.clear = clear;
+})(Clipboard || (exports.Clipboard = Clipboard = {}));

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

@@ -1,11 +1,4 @@
 import { FileInfo as ProtoFileInfo } from './proto/file-search';
-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;
-}
 /**
  * Access Vicinae's built-in file search functionality.
  *
@@ -24,7 +17,12 @@ export declare namespace FileSearch {
  *
  * @public
  */
-declare class FileSearchImpl {
+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;
     /**
     * Search for files matching the provided query string.
     *
@@ -43,7 +41,5 @@ declare class FileSearchImpl {
     * const files = await fileSearch.search('invoice');
     * ```
     */
-    search(query: string, _?: FileSearch.SearchOptions): Promise<FileSearch.FileInfo[]>;
+    function search(query: string, _?: FileSearch.SearchOptions): Promise<FileSearch.FileInfo[]>;
 }
-export declare const FileSearch: FileSearchImpl;
-export {};

package/dist/api/file-search.js

@@ -2,7 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FileSearch = void 0;
 const bus_1 = require("./bus");
-;
 /**
  * Access Vicinae's built-in file search functionality.
  *
@@ -21,7 +20,8 @@ const bus_1 = require("./bus");
  *
  * @public
  */
-class FileSearchImpl {
+var FileSearch;
+(function (FileSearch) {
     /**
     * Search for files matching the provided query string.
     *
@@ -40,10 +40,10 @@ class FileSearchImpl {
     * const files = await fileSearch.search('invoice');
     * ```
     */
-    async search(query, _ = {}) {
+    async function search(query, _ = {}) {
         const res = await bus_1.bus.turboRequest('fileSearch.search', { query });
         return res.unwrap().files;
     }
-}
+    FileSearch.search = search;
+})(FileSearch || (exports.FileSearch = FileSearch = {}));
 ;
-exports.FileSearch = new FileSearchImpl();

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

@@ -1,5 +1,21 @@
 import { Application } from './proto/application';
 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.
+ *
+ * @example
+ * ```typescript
+ * import { WindowManagement } from '@vicinae/api';
+ *
+ * const windows = await WindowManagement.getWindows();
+ * ```
+ *
+ * @public
+ */
 export declare namespace WindowManagement {
     type Window = {
         id: string;
@@ -23,17 +39,11 @@ export declare namespace WindowManagement {
         monitorId: string;
         active: boolean;
     };
+    function ping(): Promise<boolean>;
+    function getWindows(options?: wm.GetWindowsRequest): Promise<WindowManagement.Window[]>;
+    function getActiveWorkspace(): Promise<WindowManagement.Workspace>;
+    function getWorkspaces(): Promise<WindowManagement.Workspace[]>;
+    function getWindowsOnActiveWorkspace(): Promise<WindowManagement.Window[]>;
+    function setWindowBounds(payload: wm.SetWindowBoundsRequest): Promise<void>;
+    function getActiveWindow(): Promise<WindowManagement.Window>;
 }
-/**
- */
-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

@@ -2,7 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WindowManagement = void 0;
 const bus_1 = require("./bus");
-;
 const transformWorkspace = (proto) => {
     return {
         id: proto.id,
@@ -21,35 +20,56 @@ const transformWindow = (proto) => {
     };
 };
 /**
+ * Access Vicinae's window management features.
+ *
+ * @remarks
+ * Window management features are available to a different degree depending on what environment vicinae runs
+ * in.
+ *
+ * @example
+ * ```typescript
+ * import { WindowManagement } from '@vicinae/api';
+ *
+ * const windows = await WindowManagement.getWindows();
+ * ```
+ *
+ * @public
  */
-class WindowManagementImpl {
-    async ping() {
+var WindowManagement;
+(function (WindowManagement) {
+    async function ping() {
         const res = await bus_1.bus.turboRequest('wm.ping', {});
         return res.unwrap().ok;
     }
-    async getWindows(options = {}) {
+    WindowManagement.ping = ping;
+    async function getWindows(options = {}) {
         const res = await bus_1.bus.turboRequest('wm.getWindows', options);
         return res.unwrap().windows.map(transformWindow);
     }
-    async getActiveWorkspace() {
+    WindowManagement.getWindows = getWindows;
+    async function getActiveWorkspace() {
         const res = await bus_1.bus.turboRequest('wm.getActiveWorkspace', {});
         return transformWorkspace(res.unwrap().workspace);
     }
-    async getWorkspaces() {
+    WindowManagement.getActiveWorkspace = getActiveWorkspace;
+    async function 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 });
+    WindowManagement.getWorkspaces = getWorkspaces;
+    async function getWindowsOnActiveWorkspace() {
+        const workspace = await getActiveWorkspace();
+        return getWindows({ workspaceId: workspace.id });
     }
-    async setWindowBounds(payload) {
+    WindowManagement.getWindowsOnActiveWorkspace = getWindowsOnActiveWorkspace;
+    async function setWindowBounds(payload) {
         await bus_1.bus.turboRequest('wm.setWindowBounds', payload);
     }
-    async getActiveWindow() {
+    WindowManagement.setWindowBounds = setWindowBounds;
+    async function getActiveWindow() {
         const res = await bus_1.bus.turboRequest('wm.getActiveWindow', {});
         return transformWindow(res.unwrap().window);
     }
-}
+    WindowManagement.getActiveWindow = getActiveWindow;
+})(WindowManagement || (exports.WindowManagement = WindowManagement = {}));
 ;
-exports.WindowManagement = new WindowManagementImpl();

package/package.json

@@ -1,11 +1,13 @@
 {
   "name": "@vicinae/api",
-  "version": "0.11.0",
+  "version": "0.12.1",
   "description": "TypeScript SDK to build Vicinae extensions",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
     "build": "tsc --outDir dist",
-    "pack": "npm run build && npm pack"
+    "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"
   },
   "bin": {
     "vici": "./bin/run.js"
@@ -57,6 +59,8 @@
     "shx": "^0.3.3",
     "ts-node": "^10",
     "ts-proto": "^2.7.5",
+    "typedoc": "^0.28.13",
+    "typedoc-plugin-markdown": "^4.8.1",
     "typescript": "^5"
   },
   "oclif": {