@vicinae/api 0.16.4 → 0.16.6

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).
 
-The full API reference (expect breaking changes) can be found [here](./docs/README.md).
+The full API reference (expect breaking changes) can be found [here](https://api-reference.vicinae.com).
 
 # Installation 
 

package/dist/api/ai.d.ts

@@ -1,4 +1,7 @@
-import { ImageLike } from "./image";
+import type { ImageLike } from "./image";
+/**
+  @ignore - we don't support AI yet
+ */
 export declare namespace AI {
     /**
      * Returns a prompt completion.

package/dist/api/ai.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AI = void 0;
+/**
+  @ignore - we don't support AI yet
+ */
 var AI;
 (function (AI) {
     /**

package/dist/api/alert.d.ts

@@ -1,4 +1,7 @@
 import { Image } from "./image";
+/**
+ * @category Alert
+ */
 export declare namespace Alert {
     type Options = {
         title: string;
@@ -19,4 +22,7 @@ export declare namespace Alert {
         onAction?: () => void;
     };
 }
+/**
+ * @category Alert
+ */
 export declare const confirmAlert: (options: Alert.Options) => Promise<boolean>;

package/dist/api/alert.js

@@ -4,6 +4,9 @@ exports.confirmAlert = exports.Alert = void 0;
 const bus_1 = require("./bus");
 const image_1 = require("./image");
 const ui_1 = require("./proto/ui");
+/**
+ * @category Alert
+ */
 var Alert;
 (function (Alert) {
     let ActionStyle;
@@ -18,8 +21,11 @@ const styleMap = {
     [Alert.ActionStyle.Destructive]: ui_1.ConfirmAlertActionStyle.Destructive,
     [Alert.ActionStyle.Cancel]: ui_1.ConfirmAlertActionStyle.Cancel,
 };
+/**
+ * @category Alert
+ */
 const confirmAlert = async (options) => {
-    return new Promise(async (resolve) => {
+    return new Promise((resolve) => {
         const req = ui_1.ConfirmAlertRequest.create({
             title: options.title,
             description: options.message ?? "Are you sure?",
@@ -34,16 +40,17 @@ const confirmAlert = async (options) => {
                 style: styleMap[options.dismissAction?.style ?? Alert.ActionStyle.Cancel],
             },
         });
-        const res = await bus_1.bus.turboRequest("ui.confirmAlert", req);
-        if (!res.ok)
-            return false;
-        if (res.value.confirmed) {
-            options.primaryAction?.onAction?.();
-        }
-        else {
-            options.dismissAction?.onAction?.();
-        }
-        resolve(res.value.confirmed);
+        bus_1.bus.turboRequest("ui.confirmAlert", req).then((res) => {
+            if (!res.ok)
+                return false;
+            if (res.value.confirmed) {
+                options.primaryAction?.onAction?.();
+            }
+            else {
+                options.dismissAction?.onAction?.();
+            }
+            resolve(res.value.confirmed);
+        });
     });
 };
 exports.confirmAlert = confirmAlert;

package/dist/api/bus.d.ts

@@ -2,6 +2,9 @@ import { MessagePort } from "worker_threads";
 import * as ipc from "./proto/ipc";
 import * as extension from "./proto/extension";
 import { Result } from "./lib/result";
+/**
+ * @ignore
+ */
 export type Message<T = Record<string, any>> = {
     envelope: {
         id: string;
@@ -108,6 +111,8 @@ declare class Bus {
     private request2;
 }
 /**
+ * @ignore
+ *
  * IPC bus to communicate with the extension manager.
  * If you are using this from inside your extension, you are WRONG and you should stop.
  */

package/dist/api/bus.js

@@ -183,6 +183,8 @@ class Bus {
     }
 }
 /**
+ * @ignore
+ *
  * IPC bus to communicate with the extension manager.
  * If you are using this from inside your extension, you are WRONG and you should stop.
  */

package/dist/api/cache.d.ts

@@ -1,3 +1,6 @@
+/**
+ * @category Cache
+ */
 export declare namespace Cache {
     /**
      * The options for creating a new {@link Cache}.
@@ -28,6 +31,8 @@ export declare namespace Cache {
  * No calls to internal Vicinae APIs are required, hence why all methods in this class are synchronous.
  * Another major difference is that cache data is not encrypted, so it's not suitable to store secrets.
  * (local storage currently isn't either, but that will change in the future)
+ *
+ * @category Cache
  */
 export declare class Cache {
     constructor(options?: Cache.Options);

package/dist/api/cache.js

@@ -18,6 +18,8 @@ const environment_1 = require("./environment");
  * No calls to internal Vicinae APIs are required, hence why all methods in this class are synchronous.
  * Another major difference is that cache data is not encrypted, so it's not suitable to store secrets.
  * (local storage currently isn't either, but that will change in the future)
+ *
+ * @category Cache
  */
 class Cache {
     constructor(options) {

package/dist/api/clipboard.d.ts

@@ -1,4 +1,9 @@
 import { PathLike } from "fs";
+/**
+ * Access system clipboard and clipboard history features.
+ *
+ * @category Clipboard
+ */
 export declare namespace Clipboard {
     type Content = {
         text: string;

package/dist/api/clipboard.js

@@ -3,6 +3,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Clipboard = void 0;
 const bus_1 = require("./bus");
 const clipboard_1 = require("./proto/clipboard");
+/**
+ * Access system clipboard and clipboard history features.
+ *
+ * @category Clipboard
+ */
 var Clipboard;
 (function (Clipboard) {
     function mapContent(content) {

package/dist/api/color.d.ts

@@ -4,10 +4,16 @@ type DynamicColor = {
     light: string;
     adjustContrast?: boolean;
 };
+/**
+ * @category Colors
+ */
 export declare namespace Color {
     type Dynamic = DynamicColor;
     type Raw = string;
 }
+/**
+ * @category Colors
+ */
 export declare enum Color {
     Blue = "blue",
     Green = "green",
@@ -19,6 +25,9 @@ export declare enum Color {
     PrimaryText = "primary-text",
     SecondaryText = "secondary-text"
 }
+/**
+ * @category Colors
+ */
 export type ColorLike = Color.Dynamic | Color.Raw | Color;
 export type SerializedColorLike = ui.ColorLike;
 export declare const serializeColorLike: (color: ColorLike) => SerializedColorLike;

package/dist/api/color.js

@@ -35,6 +35,9 @@ var __importStar = (this && this.__importStar) || (function () {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.serializeColorLike = exports.Color = void 0;
 const ui = __importStar(require("./proto/ui"));
+/**
+ * @category Colors
+ */
 var Color;
 (function (Color) {
     Color["Blue"] = "blue";

package/dist/api/components/action-pannel.d.ts

@@ -1,23 +1,35 @@
 import type { ReactNode } from "react";
-import { type Image } from "../image";
 import type { Keyboard } from "../keyboard";
-export type ActionPanelProps = {
-    title?: string;
-    children?: ReactNode;
-};
-export type ActionPanelSectionProps = {
-    title?: string;
-    children?: ReactNode;
-};
-export type ActionPanelSubmenuProps = {
-    title: string;
-    icon?: Image.ImageLike;
-    shortcut?: Keyboard.Shortcut;
-    onOpen?: () => void;
-    onSearchTextChange?: (text: string) => void;
-    children: ReactNode;
-};
-export declare const ActionPanel: import("react").FC<ActionPanelProps> & {
-    Section: import("react").FC<import("react").PropsWithChildren<ActionPanelSectionProps>>;
-    Submenu: import("react").FC<ActionPanelSubmenuProps>;
+import { type Image } from "../image";
+/**
+ * @category Actions
+ */
+export declare namespace ActionPanel {
+    type Props = {
+        title?: string;
+        children?: ReactNode;
+    };
+    namespace Section {
+        type Props = {
+            title?: string;
+            children?: ReactNode;
+        };
+    }
+    namespace Submenu {
+        type Props = {
+            title: string;
+            icon?: Image.ImageLike;
+            shortcut?: Keyboard.Shortcut;
+            onOpen?: () => void;
+            onSearchTextChange?: (text: string) => void;
+            children: ReactNode;
+        };
+    }
+}
+/**
+ * @category Actions
+ */
+export declare const ActionPanel: import("react").FC<ActionPanel.Props> & {
+    Section: import("react").FC<import("react").PropsWithChildren<ActionPanel.Section.Props>>;
+    Submenu: import("react").FC<ActionPanel.Submenu.Props>;
 };

package/dist/api/components/action-pannel.js

@@ -17,6 +17,9 @@ const ActionPannelSubmenu = ({ children, icon, ...props }) => {
     const serializedIcon = icon ? (0, image_1.serializeProtoImage)(icon) : icon;
     return ((0, jsx_runtime_1.jsx)("action-panel-submenu", { ...props, icon: serializedIcon, children: children }));
 };
+/**
+ * @category Actions
+ */
 exports.ActionPanel = Object.assign(ActionPanelRoot, {
     Section: ActionPanelSection,
     Submenu: ActionPannelSubmenu,

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

@@ -2,11 +2,11 @@ import React, { ReactNode } from "react";
 import type { PathLike } from "node:fs";
 import { Clipboard } from "../clipboard";
 import { type ImageLike } from "../image";
-import { Keyboard } from "../keyboard";
+import type { Keyboard } from "../keyboard";
 import { Application } from "../utils";
-import { Form } from "./form";
+import type { Form } from "./form";
 import { Icon } from "../icon";
-export type BaseActionProps = {
+type BaseActionProps = {
     title: string;
     icon?: ImageLike;
     /**
@@ -18,61 +18,90 @@ export type BaseActionProps = {
     autoFocus?: boolean;
     style?: "regular" | "destructive";
 };
-export type ActionProps = BaseActionProps & {
+type ActionProps = BaseActionProps & {
     onAction: () => void;
 };
-export type CopyToClipboardProps = Omit<BaseActionProps, "title"> & {
-    content: string;
-    concealed?: boolean;
-    onCopy?: (content: string | number | Clipboard.Content) => void;
-    title?: string;
-};
-export type ActionPushProps = BaseActionProps & {
-    target: ReactNode;
-};
-export type ActionOpenProps = BaseActionProps & {
-    target: string;
-    app?: Application;
-};
-export type ActionPasteProps = BaseActionProps & {
-    content: string;
-    onPaste?: (content: string | number | Clipboard.Content) => void;
-};
-export type ActionOpenInBrowserProps = BaseActionProps & {
-    url: string;
-};
-export type ActionShowInFinderProps = {
-    path: PathLike;
-    icon?: ImageLike;
-    onShow?: (path: PathLike) => void;
-    shortcut?: Keyboard.Shortcut;
-    title?: string;
-};
-export type ActionSubmitFormProps = Omit<BaseActionProps, "title"> & {
-    onSubmit: (input: Form.Values) => boolean | void | Promise<boolean | void>;
-    title?: string;
-};
+/**
+ * Actions that can be used as part of an {@link ActionPanel}
+ *
+ * Most actions are just simple wrappers around the base {@link Action}. For any custom need, use that.
+ *
+ * @category Actions
+ */
+export declare namespace Action {
+    namespace CopyToClipboard {
+        type Props = Omit<BaseActionProps, "title"> & {
+            content: string;
+            concealed?: boolean;
+            onCopy?: (content: string | number | Clipboard.Content) => void;
+            title?: string;
+        };
+    }
+    namespace Push {
+        type Props = BaseActionProps & {
+            target: ReactNode;
+        };
+    }
+    namespace Open {
+        type Props = BaseActionProps & {
+            target: string;
+            app?: Application;
+        };
+    }
+    namespace Paste {
+        type Props = BaseActionProps & {
+            content: string;
+            onPaste?: (content: string | number | Clipboard.Content) => void;
+        };
+    }
+    namespace OpenInBrowser {
+        type Props = BaseActionProps & {
+            url: string;
+        };
+    }
+    namespace ShowInFinderProps {
+        type Props = {
+            path: PathLike;
+            icon?: ImageLike;
+            onShow?: (path: PathLike) => void;
+            shortcut?: Keyboard.Shortcut;
+            title?: string;
+        };
+    }
+    namespace SubmitForm {
+        type Props = Omit<BaseActionProps, "title"> & {
+            onSubmit: (input: Form.Values) => boolean | void | Promise<boolean | void>;
+            title?: string;
+        };
+    }
+    namespace CreateQuicklink {
+        type Props = Omit<BaseActionProps, "title"> & {
+            title?: string;
+            quicklink: Quicklink;
+        };
+    }
+}
 export type Quicklink = {
     name?: string;
     link: string;
     application?: string | Application;
     icon?: Icon;
 };
-export type ActionCreateQuicklinkProps = Omit<BaseActionProps, "title"> & {
-    title?: string;
-    quicklink: Quicklink;
-};
+/**
+ * @category Actions
+ */
 export declare const Action: React.FC<ActionProps> & {
-    CopyToClipboard: React.FC<CopyToClipboardProps>;
-    Push: React.FC<ActionPushProps>;
-    Open: React.FC<ActionOpenProps>;
-    Paste: React.FC<ActionPasteProps>;
-    SubmitForm: React.FC<ActionSubmitFormProps>;
-    OpenInBrowser: React.FC<ActionOpenInBrowserProps>;
-    ShowInFinder: React.FC<ActionShowInFinderProps>;
-    CreateQuicklink: React.FC<ActionCreateQuicklinkProps>;
+    CopyToClipboard: React.FC<Action.CopyToClipboard.Props>;
+    Push: React.FC<Action.Push.Props>;
+    Open: React.FC<Action.Open.Props>;
+    Paste: React.FC<Action.Paste.Props>;
+    SubmitForm: React.FC<Action.SubmitForm.Props>;
+    OpenInBrowser: React.FC<Action.OpenInBrowser.Props>;
+    ShowInFinder: React.FC<Action.ShowInFinderProps.Props>;
+    CreateQuicklink: React.FC<Action.CreateQuicklink.Props>;
     Style: {
         Regular: "regular";
         Destructive: "destructive";
     };
 };
+export {};

package/dist/api/components/actions.js

@@ -77,6 +77,9 @@ const CreateQuicklink = ({ title = "Create Quicklink", quicklink, ...props }) =>
     };
     return (0, jsx_runtime_1.jsx)("action", { ...nativeProps });
 };
+/**
+ * @category Actions
+ */
 exports.Action = Object.assign(ActionRoot, {
     CopyToClipboard,
     Push,

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

@@ -1,11 +1,36 @@
-import { ReactNode } from "react";
-export type DetailProps = {
-    navigationTitle?: string;
-    metadata?: ReactNode;
-    markdown: string;
-    actions?: ReactNode;
-};
-export declare const Detail: import("react").FC<DetailProps> & {
+import type { ReactNode } from "react";
+/**
+ * ![](../../../assets/detail.png)
+ *
+ * A Detail component is commonly used to render markdown with an optional metadata side panel on the right.
+ *
+ * @remarks
+ * The markdown renderer is currently very bare bones and does not have good support for most fancy markdown features. This is actively being worked on.
+ *
+ * @example
+ * ```typescript
+ * import { Detail } from '@vicinae/api';
+ *
+ * export default function MyCommand() {
+ *  return <Detail markdown={'# Hello world!'} />;
+ * }
+ * ```
+ *
+ * @category UI Components
+ * @public
+ */
+export declare namespace Detail {
+    type Props = {
+        navigationTitle?: string;
+        metadata?: ReactNode;
+        markdown: string;
+        actions?: ReactNode;
+    };
+}
+/**
+ * @category UI Components
+ */
+export declare const Detail: import("react").FC<Detail.Props> & {
     Metadata: import("react").FC<import("./metadata").MetadataProps> & {
         Label: import("react").FC<import("./metadata").ListItemDetailMetadataLabelProps>;
         Separator: import("react").FC<{}>;

package/dist/api/components/detail.js

@@ -7,6 +7,9 @@ const DetailRoot = ({ metadata, actions, ...props }) => {
     const nativeProps = props;
     return ((0, jsx_runtime_1.jsxs)("detail", { ...nativeProps, children: [actions, metadata] }));
 };
+/**
+ * @category UI Components
+ */
 exports.Detail = Object.assign(DetailRoot, {
     Metadata: metadata_1.Metadata,
 });

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

@@ -1,14 +1,33 @@
-import { ReactNode, Ref } from "react";
+import type { ReactNode, Ref } from "react";
 import { type ImageLike } from "../image";
-type FormProps = {
-    actions?: React.ReactNode;
-    children?: React.ReactNode;
-    enableDrafts?: boolean;
-    isLoading?: boolean;
-    navigationTitle?: string;
-    searchBarAccessory?: React.ReactNode;
-};
-export type FormItemRef = {
+/**
+ * @category UI Components
+ */
+export declare namespace Form {
+    type Props = {
+        actions?: React.ReactNode;
+        children?: React.ReactNode;
+        enableDrafts?: boolean;
+        isLoading?: boolean;
+        navigationTitle?: string;
+        searchBarAccessory?: React.ReactNode;
+    };
+    type TextField = FormItemRef;
+    type PasswordField = FormItemRef;
+    type TextArea = FormItemRef;
+    type Checkbox = FormItemRef;
+    type DatePicker = FormItemRef;
+    type Dropdown = FormItemRef;
+    type TagPicker = FormItemRef;
+    type FilePicker = FormItemRef;
+    type ItemReference = FormItemRef;
+    type ItemProps<T extends Value> = FormItemProps<T>;
+    type Value = string | number | boolean | string[] | number[] | Date | null;
+    type Values = {
+        [itemId: string]: Value;
+    };
+}
+type FormItemRef = {
     focus: () => void;
     reset: () => void;
 };
@@ -33,23 +52,6 @@ interface FormEvent<T extends Form.Value> {
     type: FormEventType;
 }
 type FormEventType = "focus" | "blur";
-export declare namespace Form {
-    type Props = FormProps;
-    type TextField = FormItemRef;
-    type PasswordField = FormItemRef;
-    type TextArea = FormItemRef;
-    type Checkbox = FormItemRef;
-    type DatePicker = FormItemRef;
-    type Dropdown = FormItemRef;
-    type TagPicker = FormItemRef;
-    type FilePicker = FormItemRef;
-    type ItemReference = FormItemRef;
-    type ItemProps<T extends Value> = FormItemProps<T>;
-    type Value = string | number | boolean | string[] | number[] | Date | null;
-    type Values = {
-        [itemId: string]: Value;
-    };
-}
 interface WithFormRef<T> {
     ref?: Ref<T>;
 }
@@ -93,7 +95,10 @@ type DescriptionProps = {
     text: string;
     title?: string;
 };
-export declare const Form: import("react").FC<FormProps> & {
+/**
+ * @category UI Components
+ */
+export declare const Form: import("react").FC<Form.Props> & {
     TextField: import("react").FC<TextFieldProps>;
     PasswordField: import("react").FC<PasswordFieldProps>;
     DatePicker: import("react").FC<DatePickerProps> & {

package/dist/api/components/form.js

@@ -99,6 +99,9 @@ const FilePicker = ({ ref, ...props }) => {
 const Description = (props) => {
     return (0, jsx_runtime_1.jsx)("form-description", { ...props });
 };
+/**
+ * @category UI Components
+ */
 exports.Form = Object.assign(FormRoot, {
     TextField,
     PasswordField,