@raycast/api 1.30.3 → 1.32.1

package/types/api/app/app.d.ts

@@ -1,171 +0,0 @@
-/// <reference types="node" />
-import { PathLike } from "fs";
-/**
- * Closes the main Raycast window.
- *
- * @param options - Can be used to clear the root search. Defaults to not clearing the root search after
- * the window was closed.
- * @returns A Promise that resolves when the main window is closed.
- *
- * @example
- * ```typescript
- * import { closeMainWindow } from "@raycast/api";
- * import { setTimeout } from "timers/promises";
- *
- * export default async () => {
- *   await setTimeout(1000);
- *   await closeMainWindow({ clearRootSearch: true });
- * };
- * ```
- */
-export declare function closeMainWindow(options?: {
-    clearRootSearch?: boolean;
-}): Promise<void>;
-/**
- * Pops the navigation stack back to root search.
- *
- * @param options - Can be used to clear the search bar. Defaults to clearing the search bar after popped to root.
- * @returns A Promise that resolves when Raycast popped to root.
- *
- * @example
- * ```typescript
- * import { Detail, popToRoot } from "@raycast/api";
- * import { useEffect } from "react";
- * import { setTimeout } from "timers";
- *
- * export default function Command() {
- *   useEffect(() => {
- *     setTimeout(() => {
- *       popToRoot({ clearSearchBar: true });
- *     }, 3000);
- *   }, []);
- *
- *   return <Detail markdown="See you soon 👋" />;
- * }
- * ```
- */
-export declare function popToRoot(options?: {
-    clearSearchBar?: boolean;
-}): Promise<void>;
-/**
- * Clear the text in the search bar.
- *
- * @param options - Can be used to force scrolling to the top. Defaults to scrolling to the top after the
- * the search bar was cleared.
- * @returns A Promise that resolves when the search bar is cleared.
- */
-export declare function clearSearchBar(options?: {
-    forceScrollToTop?: boolean;
-}): Promise<void>;
-/**
- * Utils
- */
-/**
- * Shows a file or directory in the Finder.
- *
- * @param path - The path to show in the Finder.
- * @returns A Promise that resolves when the item is revealed in the Finder.
- *
- * @example
- * ```typescript
- * import { showInFinder } from "@raycast/api"
- * import { homedir } from "os"
- * import { join } from "path"
- * showInFinder(join(homedir(), "Downloads"))
- * ```
- */
-export declare function showInFinder(path: PathLike): Promise<void>;
-/**
- * Moves a file or directory to the Trash.
- *
- * @param paths - The item or items to move to the trash.
- * @returns A Promise that resolves when all files are moved to the trash.
- *
- * @example
- * ```typescript
- * import { trash } from "@raycast/api";
- * import { writeFile } from "fs/promises";
- * import { homedir } from "os";
- *
- * export default async () => {
- *   const file = `${homedir()}/Desktop/yolo.txt`;
- *   await writeFile(file, "I will be deleted soon!");
- *   await trash(file);
- * };
- * ```
- */
-export declare function trash(path: PathLike | PathLike[]): Promise<void>;
-/**
- * An object that represents a locally installed application on the system.
- *
- * @remarks
- * It can be used to open files or folders in a specific application. Use {@link getApplications} or
- * {@link getDefaultApplication} to get applications that can open a specific file or folder.
- */
-export interface Application {
-    /**
-     * The display name of the application.
-     */
-    name: string;
-    /**
-     * The absolute path to the application bundle, e.g. `/Applications/Raycast.app`,
-     */
-    path: string;
-    /**
-     * The bundle identifier of the application, e.g. `com.raycast.macos`.
-     */
-    bundleId?: string;
-}
-/**
- * Returns all applications that can open the file.
- *
- * @param path The path of the file or folder to get the applications for. If no path is specified, all installed applications are returned.
- * @returns An array of {@link Application}.
- *
- * @example
- * ```typescript
- * import { getApplications } from "@raycast/api";
- *
- * export default async () => {
- *   const installedApplications = await getApplications();
- *   console.log("The following applications are installed on your Mac:");
- *   console.log(installedApplications.map((a) => a.name).join(", "));
- * };
- * ```
- */
-export declare function getApplications(path?: PathLike): Promise<Application[]>;
-/**
- * Returns the default application that the file would be opened with.
- *
- * @param path The path of the file or folder to get the default application for.
- * @returns The default {@link Application} that would open the file. Throws an error if no application was found.
- *
- * @example
- * ```typescript
- * import { getDefaultApplication } from "@raycast/api";
- *
- * export default async () => {
- *   const defaultApplication = await getDefaultApplication(__filename);
- *   console.log(`Default application for JavaScript is: ${defaultApplication.name}`);
- * };
- * ```
- */
-export declare function getDefaultApplication(path: PathLike): Promise<Application>;
-/**
- * Opens a target with the default application or specified application.
- *
- * @param target The file, folder or URL to open.
- * @param application The application name to use for opening the file. If no application is specified, the default application as determined by the system
- * is used to open the specified file. Note that you can use the application name, app identifier, or absolute path to the app.
- * @returns A Promise that resolves when the target has been opened.
- *
- * @example
- * ```typescript
- * import { open } from "@raycast/api";
- *
- * export default async () => {
- *   await open("https://www.raycast.com", "com.google.Chrome");
- * };
- * ```
- */
-export declare function open(target: string, application?: Application | string): Promise<void>;

package/types/api/app/clipboard.d.ts

@@ -1,63 +0,0 @@
-/**
- * Copies text to the clipboard.
- *
- * @param text - The text to copy to the clipboard.
- * @returns A Promise that resolves when the text is copied to the clipboard.
- *
- * @example
- * ```typescript
- * import { Clipboard } from "@raycast/api";
- *
- * export default async () => {
- *   await Clipboard.copy("https://raycast.com");
- * };
- * ```
- */
-export declare function copy(text: string): Promise<void>;
-/**
- * Clears the current clipboard contents.
- *
- * @returns A Promise that resolves when the clipboard is cleared.
- *
- * @example
- * ```typescript
- * import { Clipboard } from "@raycast/api";
- *
- * export default async () => {
- *   await Clipboard.clear();
- * };
- * ```
- */
-export declare function clear(): Promise<void>;
-/**
- * Pastes text to the current selection of the frontmost application.
- *
- * @param text - The text to insert at the cursor.
- * @returns A Promise that resolves when the text is pasted.
- *
- * @example
- * ```typescript
- * import { Clipboard } from "@raycast/api";
- *
- * export default async () => {
- *   await Clipboard.paste("I really like Raycast's API");
- * };
- * ```
- */
-export declare function paste(text: string): Promise<void>;
-/**
- * Reads the clipboard as plain text.
- *
- * @returns A promise that resolves when the clipboard content was read as plain text.
- *
- * @example
- * ```typescript
- * import { Clipboard } from "@raycast/api";
- *
- * export default async () => {
- *   const text = await Clipboard.readText();
- *   console.log(text);
- * };
- * ```
- */
-export declare function readText(): Promise<string | undefined>;

package/types/api/app/index.d.ts

@@ -1,4 +0,0 @@
-export * from "./app";
-export * as Clipboard from "./clipboard";
-export * as Keyboard from "./keyboard";
-export * as LocalStorage from "./localStorage";

package/types/api/app/keyboard.d.ts

@@ -1,56 +0,0 @@
-/**
- * A keyboard shortcut is defined by one or more modifier keys (command, control, etc.) and a single key equivalent (a character or special key).
- * See {@link KeyModifier} and {@link KeyEquivalent} for supported values.
- *
- * @example
- * ```typescript
- * import { ActionPanel, Detail, Action } from "@raycast/api";
- *
- * export default function Command() {
- *   return (
- *     <Detail markdown="Let's play some games 👾" actions={
- *       <ActionPanel title="Game controls">
- *         <Action
- *           title="Up"
- *           shortcut={{ modifiers: ["opt"], key: "arrowUp" }}
- *           onAction={() => console.log("Go up")}
- *         />
- *         <Action
- *           title="Down"
- *           shortcut={{ modifiers: ["opt"], key: "arrowDown" }}
- *           onAction={() => console.log("Go down")}
- *         />
- *         <Action
- *           title="Left"
- *           shortcut={{ modifiers: ["opt"], key: "arrowLeft" }}
- *           onAction={() => console.log("Go left")}
- *         />
- *         <Action
- *           title="Right"
- *           shortcut={{ modifiers: ["opt"], key: "arrowRight" }}
- *           onAction={() => console.log("Go right")}
- *         />
- *       </ActionPanel>}
- *     />
- *   );
- * }
- * ```
- */
-export interface Shortcut {
-    /**
-     * The modifier keys of the keyboard shortcut.
-     */
-    modifiers: KeyModifier[];
-    /**
-     * The key of the keyboard shortcut.
-     */
-    key: KeyEquivalent;
-}
-/**
- * Modifier of a {@link Shortcut}
- */
-export declare type KeyModifier = "cmd" | "ctrl" | "opt" | "shift";
-/**
- * KeyEquivalent of a {@link Shortcut}
- */
-export declare type KeyEquivalent = "a" | "b" | "c" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "r" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "." | "," | ";" | "=" | "+" | "-" | "[" | "]" | "{" | "}" | "«" | "»" | "(" | ")" | "/" | "\\" | "'" | "`" | "§" | "^" | "@" | "$" | "return" | "delete" | "deleteForward" | "tab" | "arrowUp" | "arrowDown" | "arrowLeft" | "arrowRight" | "pageUp" | "pageDown" | "home" | "end" | "space" | "escape" | "enter" | "backspace";

package/types/api/app/localStorage.d.ts

@@ -1,117 +0,0 @@
-/**
- * Retrieve all stored values in the local storage of an extension.
- *
- * @returns A Promise that resolves with an object containing all {@link Values}.
- *
- * @example
- * ```typescript
- * import { LocalStorage } from "@raycast/api";
- *
- * interface Values {
- *   todo: string;
- *   priority: number;
- * }
- *
- * export default async () => {
- *   const items = await LocalStorage.allItems<Values>();
- *   console.log(`Local storage item count: ${Object.entries(items).length}`);
- * };
- * ```
- */
-export declare function allItems<T extends Values = Values>(): Promise<T>;
-/**
- * Retrieve the stored value for the given key.
- *
- * @param key - The key you want to retrieve the value of.
- * @returns A Promise that resolves with the stored value for the given key. If the key does not exist, `undefined` is returned.
- *
- * @example
- * ```typescript
- * import { LocalStorage } from "@raycast/api";
- *
- * export default async () => {
- *   const item = await LocalStorage.getItem<string>("favorite-fruit");
- *   console.log(item);
- * };
- * ```
- */
-export declare function getItem<T extends Value = Value>(key: string): Promise<T | undefined>;
-/**
- * Stores a value for the given key.
- *
- * @param key - The key you want to create or update the value of.
- * @param value - The value you want to create or update for the given key.
- * @returns A Promise that resolves when the value is stored.
- *
- * @example
- * ```typescript
- * import { LocalStorage } from "@raycast/api";
- *
- * export default async () => {
- *   await LocalStorage.setItem("favorite-fruit", "cherry");
- * };
- * ```
- */
-export declare function setItem(key: string, value: Value): Promise<void>;
-/**
- * Removes the stored value for the given key.
- *
- * @param key - The key you want to remove the value of.
- * @returns A Promise that resolves when the value is removed.
- *
- * @example
- * ```typescript
- * import { LocalStorage } from "@raycast/api";
- *
- * export default async () => {
- *   await LocalStorage.removeItem("favorite-fruit");
- * };
- * ```
- */
-export declare function removeItem(key: string): Promise<void>;
-/**
- * Removes all stored values of an extension.
- *
- * @returns A Promise that resolves when all values are removed.
- *
- * @example
- * ```typescript
- * import { LocalStorage } from "@raycast/api";
- *
- * export default async () => {
- *   await LocalStorage.clear();
- * };
- * ```
- */
-export declare function clear(): Promise<void>;
-/**
- * Supported storage value types.
- *
- * @example
- * ```typescript
- * import { LocalStorage } from "@raycast/api";
- *
- * export default async () => {
- *   // string
- *   await LocalStorage.setItem("favorite-fruit", "cherry");
- *
- *   // number
- *   await LocalStorage.setItem("fruit-basket-count", 3);
- *
- *   // boolean
- *   await LocalStorage.setItem("fruit-eaten-today", true);
- * };
- * ```
- */
-export declare type Value = string | number | boolean;
-/**
- * Values of local storage items.
- *
- * > For type-safe values, you can define your own interface. Use the keys of the local storage items as the property names.
- */
-export interface Values {
-    /**
-     * The local storage value of a given key.
-     */
-    [key: string]: any;
-}

package/types/api/components/ActionPanel.d.ts

@@ -1,261 +0,0 @@
-import { ReactElement, ReactNode } from "react";
-import { Keyboard } from "../app";
-import { Image } from "../ui";
-import PropTypes from "prop-types";
-import { Action } from "./actions";
-/**
- * Exposes a list of actions that can be performed by the user.
- *
- * @remarks
- * Often items are context-aware, e.g. based on the selected list item. Actions can be grouped into semantic
- * sections and can have keyboard shortcuts assigned.
- *
- * The first and second action become the primary and secondary action. They automatically get the default keyboard shortcuts assigned.
- * In {@link List} and {@link Detail}, this is `↵` for the primary and `⌘` `↵` for the secondary action. In {@link Form} it's `⌘` `↵` for the primary and
- * `⌘` `⇧` `↵` for the secondary.
- *
- * @example
- * ```typescript
- * import { ActionPanel, Action, List } from "@raycast/api";
- *
- * export default function Command() {
- *   return (
- *     <List navigationTitle="Open Pull Requests">
- *       <List.Item
- *         title="Docs: Update API Reference"
- *         subtitle="#1"
- *         actions={
- *           <ActionPanel title="#1 in raycast/extensions">
- *             <Action.OpenInBrowser url="https://github.com/raycast/extensions/pull/1" />
- *             <Action.CopyToClipboard
- *               title="Copy Pull Request URL"
- *               content="https://github.com/raycast/extensions/pull/1"
- *             />
- *           </ActionPanel>
- *         }
- *       />
- *     </List>
- *   );
- * }
- * ```
- */
-export declare function ActionPanel(props: ActionPanel.Props): ReactElement<ActionPanel.Props>;
-export declare namespace ActionPanel {
-    var propTypes: {
-        title: PropTypes.Requireable<string>;
-    };
-    var displayName: string;
-}
-/**
- * See {@link ActionPanel.Section}
- */
-declare function ActionPanelSection(props: ActionPanel.Section.Props): ReactElement<ActionPanel.Section.Props>;
-declare namespace ActionPanelSection {
-    var propTypes: {
-        title: PropTypes.Requireable<string>;
-    };
-    var displayName: string;
-}
-/**
- * See {@link ActionPanel.Submenu}
- */
-declare function ActionPanelSubmenu(props: ActionPanel.Submenu.Props): ReactElement<Action.Props>;
-declare namespace ActionPanelSubmenu {
-    var propTypes: {
-        id: PropTypes.Requireable<string>;
-        title: PropTypes.Validator<string>;
-        icon: PropTypes.Requireable<string | Required<PropTypes.InferProps<{
-            fileIcon: PropTypes.Validator<string>;
-        }>> | PropTypes.InferProps<{
-            source: PropTypes.Requireable<string | PropTypes.InferProps<{
-                light: PropTypes.Validator<string>;
-                dark: PropTypes.Validator<string>;
-            }>>;
-            fallback: PropTypes.Requireable<string | PropTypes.InferProps<{
-                light: PropTypes.Validator<string>;
-                dark: PropTypes.Validator<string>;
-            }>>;
-            mask: PropTypes.Requireable<Image.Mask>;
-            tintColor: PropTypes.Requireable<string | PropTypes.InferProps<{
-                light: PropTypes.Validator<string>;
-                dark: PropTypes.Validator<string>;
-                adjustContrast: PropTypes.Requireable<boolean>;
-            }>>;
-        }>>;
-        shortcut: PropTypes.Requireable<Required<PropTypes.InferProps<{
-            modifiers: PropTypes.Validator<string[]>;
-            key: PropTypes.Validator<string>;
-        }>>>;
-    };
-    var displayName: string;
-}
-export declare namespace ActionPanel {
-    /**
-     * @deprecated Use `Action` instead.
-     */
-    const Item: typeof Action;
-    /**
-     * A group of visually separated items.
-     *
-     * @remarks
-     * Use sections when the {@link ActionPanel} contains a lot of actions to help guide the user to related actions.
-     * For example, create a section for all copy actions.
-     *
-     * @example
-     * ```typescript
-     * import { ActionPanel, Action, List } from "@raycast/api";
-     *
-     * export default function Command() {
-     *   return (
-     *     <List navigationTitle="Open Pull Requests">
-     *       <List.Item
-     *         title="Docs: Update API Reference"
-     *         subtitle="#1"
-     *         actions={
-     *           <ActionPanel title="#1 in raycast/extensions">
-     *             <ActionPanel.Section title="Copy">
-     *               <Action.CopyToClipboard title="Copy Pull Request Number" content="#1" />
-     *               <Action.CopyToClipboard
-     *                 title="Copy Pull Request URL"
-     *                 content="https://github.com/raycast/extensions/pull/1"
-     *               />
-     *               <Action.CopyToClipboard title="Copy Pull Request Title" content="Docs: Update API Reference" />
-     *             </ActionPanel.Section>
-     *             <ActionPanel.Section title="Danger zone">
-     *               <Action title="Close Pull Request" onAction={() => console.log("Close PR #1")} />
-     *             </ActionPanel.Section>
-     *           </ActionPanel>
-     *         }
-     *       />
-     *     </List>
-     *   );
-     * }
-     * ```
-     */
-    const Section: typeof ActionPanelSection;
-    /**
-     * An action that replaces the current ActionPanel with its children when selected.
-     *
-     * @remarks
-     * This is handy when an action needs to select from a range of options. For example, to add a label to a GitHub pull request
-     * or an assignee to a todo.
-     *
-     * @example
-     * ```typescript
-     * import { ActionPanel, Color, Icon, List, Action } from "@raycast/api";
-     *
-     * export default function Command() {
-     *   return (
-     *     <List navigationTitle="Open Pull Requests">
-     *       <List.Item
-     *         title="Docs: Update API Reference"
-     *         subtitle="#1"
-     *         actions={
-     *           <ActionPanel title="#1 in raycast/extensions">
-     *             <ActionPanel.Submenu title="Add Label">
-     *               <Action
-     *                 icon={{ source: Icon.Circle, tintColor: Color.Red }}
-     *                 title="Bug"
-     *                 onAction={() => console.log("Add bug label")}
-     *               />
-     *               <Action
-     *                 icon={{ source: Icon.Circle, tintColor: Color.Yellow }}
-     *                 title="Enhancement"
-     *                 onAction={() => console.log("Add enhancement label")}
-     *               />
-     *               <Action
-     *                 icon={{ source: Icon.Circle, tintColor: Color.Blue }}
-     *                 title="Help Wanted"
-     *                 onAction={() => console.log("Add help wanted label")}
-     *               />
-     *             </ActionPanel.Submenu>
-     *           </ActionPanel>
-     *         }
-     *       />
-     *     </List>
-     *   );
-     * }
-     * ```
-     */
-    const Submenu: typeof ActionPanelSubmenu;
-    /**
-     * Props of the {@link ActionPanel} React component.
-     */
-    interface Props {
-        /**
-         * Sections or Actions. If {@link Action} elements are specified, a default section is automatically created.
-         */
-        children?: ReactNode;
-        /**
-         * The title displayed at the top of the panel
-         */
-        title?: string;
-    }
-    /**
-     * Supported children for the {@link ActionPanel} components.
-     */
-    type Children = ReactElement<ActionPanel.Section.Props> | ReactElement<ActionPanel.Section.Props>[] | ActionPanel.Section.Children | null;
-    namespace Section {
-        /**
-         * Props of the {@link ActionPanel.Section} React component.
-         */
-        interface Props {
-            /**
-             * The item elements of the section.
-             */
-            children?: ReactNode;
-            /**
-             * Title displayed above the section
-             */
-            title?: string;
-        }
-        /**
-         * Supported children for the {@link ActionPanel.Section} component.
-         */
-        type Children = ReactElement<Action.Props> | ReactElement<Action.Props>[] | ReactElement<ActionPanel.Submenu.Props> | Array<ReactElement<ActionPanel.Submenu.Props>> | Array<ReactElement<ActionPanel.Submenu.Props> | ReactElement<Action.Props>> | null;
-    }
-    namespace Submenu {
-        /**
-         * Props of the {@link ActionPanel.Submenu} React component.
-         */
-        interface Props {
-            /**
-             * ID of the submenu.
-             * Make sure to assign each submenu a unique ID or a UUID will be auto-generated.
-             */
-            id?: string;
-            /**
-             * The title displayed for submenu.
-             */
-            title: string;
-            /**
-             * The icon displayed for the submenu.
-             */
-            icon?: Image.ImageLike;
-            /**
-             * The keyboard shortcut for the submenu.
-             */
-            shortcut?: Keyboard.Shortcut;
-            /**
-             * Items of the submenu.
-             *
-             * @example
-             * ```typescript
-             * <ActionPanel.Submenu title="Submenu">
-             *    <Action title="Just an action" />
-             * </ActionPanel.Submenu>
-             * ```
-             *
-             * @remarks
-             * If {@link Action} elements are specified, a default section is automatically created.\
-             * Use {@link ActionPanel.Submenu} as parent when specifying sub-menu's children to make code is more readable.
-             */
-            children?: ReactNode;
-        }
-        /**
-         * Supported children for the {@link ActionPanel.Submenu} components.
-         */
-        type Children = ActionPanel.Children;
-    }
-}
-export {};