@vicinae/api 0.3.0

package/dist/api/cache.d.ts

@@ -0,0 +1,117 @@
+interface AbstractCache {
+    /**
+     * @returns the full path to the directory where the data is stored on disk.
+     */
+    get storageDirectory(): string;
+    /**
+     * @returns the data for the given key. If there is no data for the key, `undefined` is returned.
+     * @remarks If you want to just check for the existence of a key, use {@link has}.
+     */
+    get(key: string): string | undefined;
+    /**
+     * @returns `true` if data for the key exists, `false` otherwise.
+     * @remarks You can use this method to check for entries without affecting the LRU access.
+     */
+    has(key: string): boolean;
+    /**
+     * @returns `true` if the cache is empty, `false` otherwise.
+     */
+    get isEmpty(): boolean;
+    /**
+     * Sets the data for the given key.
+     * If the data exceeds the configured `capacity`, the least recently used entries are removed.
+     * This also notifies registered subscribers (see {@link subscribe}).
+     */
+    set(key: string, data: string): void;
+    /**
+     * Removes the data for the given key.
+     * This also notifies registered subscribers (see {@link subscribe}).
+     * @returns `true` if data for the key was removed, `false` otherwise.
+     */
+    remove(key: string): boolean;
+    /**
+     * Clears all stored data.
+     * This also notifies registered subscribers (see {@link subscribe}) unless the  `notifySubscribers` option is set to `false`.
+     */
+    clear(options?: {
+        notifySubscribers: boolean;
+    }): void;
+    /**
+     * Registers a new subscriber that gets notified when cache data is set or removed.
+     * @returns a function that can be called to remove the subscriber.
+     */
+    subscribe(subscriber: Cache.Subscriber): Cache.Subscription;
+}
+export declare class Cache implements AbstractCache {
+    constructor(options?: Cache.Options);
+    /**
+     * @returns the full path to the directory where the data is stored on disk.
+     */
+    get storageDirectory(): string;
+    /**
+     * @returns the data for the given key. If there is no data for the key, `undefined` is returned.
+     * @remarks If you want to just check for the existence of a key, use {@link has}.
+     */
+    get(key: string): string | undefined;
+    /**
+     * @returns `true` if data for the key exists, `false` otherwise.
+     * @remarks You can use this method to check for entries without affecting the LRU access.
+     */
+    has(key: string): boolean;
+    /**
+     * @returns `true` if the cache is empty, `false` otherwise.
+     */
+    get isEmpty(): boolean;
+    /**
+     * Sets the data for the given key.
+     * If the data exceeds the configured `capacity`, the least recently used entries are removed.
+     * This also notifies registered subscribers (see {@link subscribe}).
+     */
+    set(key: string, data: string): void;
+    /**
+     * Removes the data for the given key.
+     * This also notifies registered subscribers (see {@link subscribe}).
+     * @returns `true` if data for the key was removed, `false` otherwise.
+     */
+    remove(key: string): boolean;
+    /**
+     * Clears all stored data.
+     * This also notifies registered subscribers (see {@link subscribe}) unless the  `notifySubscribers` option is set to `false`.
+     */
+    clear(options?: {
+        notifySubscribers: boolean;
+    }): void;
+    /**
+     * Registers a new subscriber that gets notified when cache data is set or removed.
+     * @returns a function that can be called to remove the subscriber.
+     */
+    subscribe(subscriber: Cache.Subscriber): Cache.Subscription;
+    private maintainCapacity;
+    private notifySubscribers;
+}
+export declare namespace Cache {
+    /**
+     * The options for creating a new {@link Cache}.
+     */
+    interface Options {
+        /**
+         * If set, the Cache will be namespaced via a subdirectory.
+         * This can be useful to separate the caches for individual commands of an extension.
+         * By default, the cache is shared between the commands of an extension.
+         */
+        namespace?: string;
+        /**
+         * The parent directory for the cache data.
+         * @deprecated this parameter will be removed in the future – use the default directory.
+         */
+        directory?: string;
+        /**
+         * The capacity in bytes. If the stored data exceeds the capacity, the least recently used data is removed.
+         * The default capacity is 10 MB.
+         */
+        capacity?: number;
+    }
+    type Subscriber = (key: string | undefined, data: string | undefined) => void;
+    type Subscription = () => void;
+}
+export {};

package/dist/api/cache.js

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Cache = void 0;
+class Cache {
+    constructor(options) { }
+    /**
+     * @returns the full path to the directory where the data is stored on disk.
+     */
+    get storageDirectory() { return ''; }
+    /**
+     * @returns the data for the given key. If there is no data for the key, `undefined` is returned.
+     * @remarks If you want to just check for the existence of a key, use {@link has}.
+     */
+    get(key) { return undefined; }
+    /**
+     * @returns `true` if data for the key exists, `false` otherwise.
+     * @remarks You can use this method to check for entries without affecting the LRU access.
+     */
+    has(key) { return false; }
+    /**
+     * @returns `true` if the cache is empty, `false` otherwise.
+     */
+    get isEmpty() { return true; }
+    /**
+     * Sets the data for the given key.
+     * If the data exceeds the configured `capacity`, the least recently used entries are removed.
+     * This also notifies registered subscribers (see {@link subscribe}).
+     */
+    set(key, data) { }
+    /**
+     * Removes the data for the given key.
+     * This also notifies registered subscribers (see {@link subscribe}).
+     * @returns `true` if data for the key was removed, `false` otherwise.
+     */
+    remove(key) { return false; }
+    /**
+     * Clears all stored data.
+     * This also notifies registered subscribers (see {@link subscribe}) unless the  `notifySubscribers` option is set to `false`.
+     */
+    clear(options) { }
+    /**
+     * Registers a new subscriber that gets notified when cache data is set or removed.
+     * @returns a function that can be called to remove the subscriber.
+     */
+    subscribe(subscriber) {
+        return () => { };
+    }
+    maintainCapacity;
+    notifySubscribers;
+}
+exports.Cache = Cache;
+;

package/dist/api/clipboard.d.ts

@@ -0,0 +1,34 @@
+import { PathLike } from 'fs';
+import { ClipboardContent } from './proto/clipboard';
+export declare namespace Clipboard {
+    type Content = {
+        text: string;
+    } | {
+        file: PathLike;
+    } | {
+        html: string;
+        text?: string;
+    };
+    type ReadContent = {
+        text: string;
+    } | {
+        file?: string;
+    } | {
+        html?: string;
+    };
+    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?: {
+        offset?: number;
+    }): Promise<Clipboard.ReadContent>;
+    readText(options?: {
+        offset?: number;
+    }): Promise<string | undefined>;
+    clear(text: string): Promise<void>;
+};

package/dist/api/clipboard.js

@@ -0,0 +1,52 @@
+"use strict";
+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) {
+        let ct = clipboard_1.ClipboardContent.create();
+        if (typeof content != 'object') {
+            ct.text = `${content}`;
+        }
+        else {
+            if (content['file']) {
+                ct.path = { path: content['file'] };
+            }
+            else if (content['html']) {
+                ct.html = { html: content['html'], text: content['text'] };
+            }
+            else {
+                ct.text = content['text'];
+            }
+        }
+        return ct;
+    },
+    async copy(text, options = {}) {
+        await bus_1.bus.turboRequest('clipboard.copy', {
+            content: this.mapContent(text),
+            options: { concealed: options.concealed ?? false }
+        });
+    },
+    async paste(text) {
+        await bus_1.bus.turboRequest('clipboard.paste', {
+            content: this.mapContent(text),
+        });
+    },
+    async read(options) {
+        const res = await bus_1.bus.request('clipboard.read', {
+            options
+        });
+        return res.data.content;
+    },
+    async readText(options) {
+        const res = await bus_1.bus.request('clipboard.read-text', {
+            options
+        });
+        return res.data.content;
+    },
+    async clear(text) {
+        // TODO: implement
+    }
+};

package/dist/api/color.d.ts

@@ -0,0 +1,24 @@
+type DynamicColor = {
+    dark: string;
+    light: string;
+    adjustContrast?: boolean;
+};
+export declare namespace Color {
+    type Dynamic = DynamicColor;
+    type Raw = string;
+}
+export declare enum Color {
+    Blue = "blue",
+    Green = "green",
+    Magenta = "magenta",
+    Orange = "orange",
+    Purple = "purple",
+    Red = "red",
+    Yellow = "yellow",
+    PrimaryText = "primary-text",
+    SecondaryText = "secondary-text"
+}
+export type ColorLike = Color.Dynamic | Color.Raw | Color;
+export type SerializedColorLike = Color.Dynamic | string;
+export declare const serializeColorLike: (color: ColorLike) => SerializedColorLike;
+export {};

package/dist/api/color.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.serializeColorLike = exports.Color = void 0;
+;
+var Color;
+(function (Color) {
+    Color["Blue"] = "blue";
+    Color["Green"] = "green";
+    Color["Magenta"] = "magenta";
+    Color["Orange"] = "orange";
+    Color["Purple"] = "purple";
+    Color["Red"] = "red";
+    Color["Yellow"] = "yellow";
+    Color["PrimaryText"] = "primary-text";
+    Color["SecondaryText"] = "secondary-text";
+})(Color || (exports.Color = Color = {}));
+;
+const serializeColorLike = (color) => {
+    if (typeof color == 'string') {
+        return color;
+    }
+    return color;
+};
+exports.serializeColorLike = serializeColorLike;

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

@@ -0,0 +1,23 @@
+import { ReactNode } from "react";
+import { Image } from "../image";
+import { 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>;
+};

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

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ActionPanel = void 0;
+const jsx_runtime_1 = require("react/jsx-runtime");
+const image_1 = require("../image");
+const hooks_1 = require("../hooks");
+const ActionPanelRoot = (props) => {
+    const nativeProps = props;
+    return ((0, jsx_runtime_1.jsx)("action-panel", { ...nativeProps }));
+};
+const ActionPanelSection = (props) => {
+    const nativeProps = {
+        title: props.title,
+    };
+    return ((0, jsx_runtime_1.jsx)("action-panel-section", { ...nativeProps, children: props.children }));
+};
+const ActionPannelSubmenu = ({ icon, children, onOpen, onSearchTextChange, ...props }) => {
+    const onSearchTextChangeHandler = (0, hooks_1.useEventListener)(onSearchTextChange);
+    const onOpenHandler = (0, hooks_1.useEventListener)(onOpen);
+    const nativeProps = props;
+    nativeProps.onSearchTextChange = onSearchTextChangeHandler;
+    nativeProps.onOpen = onOpenHandler;
+    if (icon)
+        nativeProps.icon = (0, image_1.serializeImageLike)(icon);
+    return (0, jsx_runtime_1.jsx)("action-panel-submenu", { ...nativeProps, children: children });
+};
+exports.ActionPanel = Object.assign(ActionPanelRoot, {
+    Section: ActionPanelSection,
+    Submenu: ActionPannelSubmenu,
+});

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

@@ -0,0 +1,52 @@
+import React, { ReactNode } from "react";
+import { Clipboard } from "../clipboard";
+import { ImageLike } from "../image";
+import { Keyboard } from "../keyboard";
+import { Application } from "../utils";
+import { Form } from "./form";
+export type BaseActionProps = {
+    title: string;
+    icon?: ImageLike;
+    shortcut?: Keyboard.Shortcut;
+    autoFocus?: boolean;
+    style?: 'regular' | 'destructive';
+};
+export 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 ActionSubmitFormProps = Omit<BaseActionProps, 'title'> & {
+    onSubmit: (input: Form.Values) => boolean | void | Promise<boolean | void>;
+    title?: string;
+};
+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>;
+    Style: {
+        Regular: "regular";
+        Destructive: "destructive";
+    };
+};

package/dist/api/components/actions.js

@@ -0,0 +1,81 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Action = void 0;
+const jsx_runtime_1 = require("react/jsx-runtime");
+const index_1 = require("../hooks/index");
+const clipboard_1 = require("../clipboard");
+const image_1 = require("../image");
+const utils_1 = require("../utils");
+const hooks_1 = require("../hooks");
+const icon_1 = require("../icon");
+const controls_1 = require("../controls");
+const ActionRoot = ({ icon, ...props }) => {
+    const handler = (0, hooks_1.useEventListener)(props.onAction);
+    const nativeProps = {
+        ...props,
+        icon,
+        onAction: handler
+    };
+    if (icon) {
+        nativeProps.icon = (0, image_1.serializeImageLike)(icon);
+    }
+    return (0, jsx_runtime_1.jsx)("action", { ...nativeProps });
+};
+const CopyToClipboard = ({ title = "Copy to clipboard", icon = icon_1.Icon.CopyClipboard, content, concealed = false, onCopy, ...props }) => {
+    return (0, jsx_runtime_1.jsx)(ActionRoot, { title: title, ...props, icon: icon_1.Icon.CopyClipboard, onAction: async () => {
+            clipboard_1.Clipboard.copy(content, { concealed });
+            (0, controls_1.closeMainWindow)();
+            onCopy?.(content);
+        } });
+};
+const Paste = ({ title = "Paste to active window", icon = icon_1.Icon.CopyClipboard, content, onPaste, ...props }) => {
+    return (0, jsx_runtime_1.jsx)(ActionRoot, { title: title, ...props, icon: icon_1.Icon.CopyClipboard, onAction: async () => {
+            (0, controls_1.closeMainWindow)(); // we close before pasting to make sure focus has been properly restored
+            clipboard_1.Clipboard.paste(content);
+            onPaste?.(content);
+        } });
+};
+const Open = ({ target, app, ...props }) => {
+    return (0, jsx_runtime_1.jsx)(ActionRoot, { ...props, onAction: () => {
+            (0, utils_1.open)(target, app);
+        } });
+};
+const OpenInBrowser = ({ url, ...props }) => {
+    return (0, jsx_runtime_1.jsx)(ActionRoot, { ...props, onAction: () => {
+            (0, utils_1.open)(url);
+        } });
+};
+const Push = ({ target, ...props }) => {
+    const { push } = (0, index_1.useNavigation)();
+    return (0, jsx_runtime_1.jsx)(ActionRoot, { ...props, onAction: () => {
+            console.log('activate push action');
+            push(target);
+        } });
+};
+const SubmitForm = ({ onSubmit, icon, title = "Submit", ...props }) => {
+    const submitHandler = (0, hooks_1.useEventListener)(onSubmit);
+    const handler = (0, hooks_1.useEventListener)(() => { });
+    const nativeProps = {
+        ...props,
+        title,
+        icon,
+        onSubmit: submitHandler,
+        onAction: handler
+    };
+    if (icon) {
+        nativeProps.icon = (0, image_1.serializeImageLike)(icon);
+    }
+    return (0, jsx_runtime_1.jsx)("action", { ...nativeProps });
+};
+exports.Action = Object.assign(ActionRoot, {
+    CopyToClipboard,
+    Push,
+    Open,
+    Paste,
+    SubmitForm,
+    OpenInBrowser,
+    Style: {
+        Regular: 'regular',
+        Destructive: 'destructive'
+    }
+});

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

@@ -0,0 +1,21 @@
+import { ReactNode } from 'react';
+export type DetailProps = {
+    navigationTitle?: string;
+    metadata?: ReactNode;
+    markdown: string;
+    actions?: ReactNode;
+};
+export declare const Detail: import("react").FC<DetailProps> & {
+    Metadata: import("react").FC<import("./metadata").MetadataProps> & {
+        Label: import("react").FC<import("./metadata").ListItemDetailMetadataLabelProps>;
+        Separator: import("react").FC<{}>;
+        TagList: import("react").FC<import("./tag").TagListProps> & {
+            Item: import("react").FC<import("./tag").TagItemProps>;
+        };
+        Link: import("react").FC<{
+            title: string;
+            target: string;
+            text: string;
+        }>;
+    };
+};

package/dist/api/components/detail.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Detail = void 0;
+const jsx_runtime_1 = require("react/jsx-runtime");
+const metadata_1 = require("./metadata");
+const DetailRoot = ({ metadata, actions, ...props }) => {
+    const nativeProps = props;
+    return ((0, jsx_runtime_1.jsxs)("detail", { ...nativeProps, children: [actions, metadata] }));
+};
+exports.Detail = Object.assign(DetailRoot, {
+    Metadata: metadata_1.Metadata
+});

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

@@ -0,0 +1,36 @@
+import { ReactNode } from "react";
+import { Image } from "../image";
+export declare namespace Dropdown {
+    type Props = DropdownProps;
+    type Item = DropdownItemProps;
+    type Section = DropdownSectionProps;
+}
+type DropdownProps = {
+    tooltip?: string;
+    children?: ReactNode;
+    defaultValue?: string;
+    filtering?: boolean;
+    id?: string;
+    isLoading?: boolean;
+    placeholder?: string;
+    storeValue?: boolean;
+    throttle?: boolean;
+    value?: string;
+    onChange?: (newValue: string) => void;
+    onSearchTextChange?: (text: string) => void;
+};
+type DropdownItemProps = {
+    title: string;
+    value: string;
+    icon?: Image.ImageLike;
+    keywords?: string[];
+};
+type DropdownSectionProps = {
+    title?: string;
+    children?: ReactNode;
+};
+export declare const Dropdown: import("react").FC<DropdownProps> & {
+    Item: import("react").FC<DropdownItemProps>;
+    Section: import("react").FC<DropdownSectionProps>;
+};
+export {};

package/dist/api/components/dropdown.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Dropdown = void 0;
+const jsx_runtime_1 = require("react/jsx-runtime");
+const image_1 = require("../image");
+const hooks_1 = require("../hooks");
+const DropdownRoot = ({ children, ...props }) => {
+    const onSearchTextChange = (0, hooks_1.useEventListener)(props.onSearchTextChange);
+    const onChange = (0, hooks_1.useEventListener)(props.onChange);
+    return ((0, jsx_runtime_1.jsx)("dropdown", { onSearchTextChange: onSearchTextChange, onChange: onChange, children: children }));
+};
+const Item = ({ title, value, icon }) => {
+    return (0, jsx_runtime_1.jsx)("dropdown-item", { title: title, value: value, icon: icon && (0, image_1.serializeImageLike)(icon) });
+};
+const Section = ({ title, children }) => {
+    return ((0, jsx_runtime_1.jsx)("dropdown-section", { title: title, children: children }));
+};
+exports.Dropdown = Object.assign(DropdownRoot, {
+    Item,
+    Section
+});

package/dist/api/components/empty-view.d.ts

@@ -0,0 +1,9 @@
+import React, { ReactNode } from 'react';
+import { ImageLike } from '../image';
+export type EmptyViewProps = {
+    title?: string;
+    icon?: ImageLike;
+    description?: string;
+    actions?: ReactNode;
+};
+export declare const EmptyView: React.FC<EmptyViewProps>;

package/dist/api/components/empty-view.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EmptyView = void 0;
+const jsx_runtime_1 = require("react/jsx-runtime");
+const image_1 = require("../image");
+const EmptyView = ({ icon, actions, ...props }) => {
+    const nativeProps = props;
+    if (icon)
+        nativeProps.icon = (0, image_1.serializeImageLike)(icon);
+    return ((0, jsx_runtime_1.jsx)("empty-view", { ...nativeProps, children: actions }));
+};
+exports.EmptyView = EmptyView;