@raycast/api 1.30.2 → 1.32.0

package/types/api/environment/environment.d.ts

@@ -1,48 +0,0 @@
-/**
- * Holds data about the environment the command is running in. Use the global {@link environment} object to retrieve values.
- */
-export interface Environment {
-    /**
-     * The version of the main Raycast app
-     */
-    raycastVersion: string;
-    /**
-     * The name of the extension, as specified in package.json
-     */
-    extensionName: string;
-    /**
-     * The name of the launched command, as specified in package.json
-     */
-    commandName: string;
-    /**
-     * The absolute path to the assets directory of the extension.
-     *
-     * @remarks
-     * This directory is used internally to load icons, images, and other bundled assets.
-     */
-    assetsPath: string;
-    /**
-     * The absolute path for the support directory of an extension. Use it to read and write files related to your extension or command.
-     */
-    supportPath: string;
-    /**
-     * Indicates whether the command is a development command (vs. an installed command from the Store).
-     */
-    isDevelopment: boolean;
-}
-/**
- * Contains environment values such as the Raycast version, extension info, and paths.
- *
- * @example
- * ```typescript
- * import { environment } from "@raycast/api";
- *
- * console.log(`Raycast version: ${environment.raycastVersion}`);
- * console.log(`Extension name: ${environment.extensionName}`);
- * console.log(`Command name: ${environment.commandName}`);
- * console.log(`Assets path: ${environment.assetsPath}`);
- * console.log(`Support path: ${environment.supportPath}`);
- * console.log(`Is development mode: ${environment.isDevelopment}`);
- * ```
- */
-export declare const environment: Environment;

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

@@ -1,3 +0,0 @@
-export * from "./environment";
-export * from "./preferences";
-export * from "./workspace";

package/types/api/environment/preferences.d.ts

@@ -1,31 +0,0 @@
-/**
- * Values of preference items.
- */
-export interface PreferenceValues {
-    [name: string]: any;
-}
-/**
- * A function to access the preference values that have been passed to the command.
- *
- * @returns An object with the preference names as property key and the typed value as property value.
- *
- * @remarks
- * Each preference name is mapped to its value and the defined default values are used as fallback values.
- *
- * @example
- * ```typescript
- * import { getPreferenceValues } from "@raycast/api";
- *
- * interface Preferences {
- *   name: string;
- *   bodyWeight?: string;
- *   bodyHeight?: string;
- * }
- *
- * export default async () => {
- *   const preferences = getPreferenceValues<Preferences>();
- *   console.log(preferences);
- * };
- * ```
- */
-export declare function getPreferenceValues<Values extends PreferenceValues = PreferenceValues>(): Values;

package/types/api/environment/workspace.d.ts

@@ -1,62 +0,0 @@
-/**
- * Gets the selected text of the frontmost application.
- *
- * @throws An error when no text is selected in the frontmost application.
- * @returns A Promise that resolves with the selected text.
- *
- * @example
- * ```typescript
- * import { getSelectedText, Clipboard, showToast, Toast } from "@raycast/api";
- *
- * export default async () => {
- *   try {
- *     const selectedText = await getSelectedText();
- *     const transformedText = selectedText.toUpperCase();
- *     await Clipboard.paste(transformedText);
- *   } catch (error) {
- *     await showToast({
- *       style: Toast.Style.Failure,
- *       title: "Cannot transform text",
- *       message: String(error)
- *     });
- *   }
- * };
- * ```
- */
-export declare function getSelectedText(): Promise<string>;
-/**
- * Holds data about a File System item. Use the {@link getSelectedFinderItems} method to retrieve values.
- */
-export interface FileSystemItem {
-    /**
-     * The path to the item
-     */
-    path: string;
-}
-/**
- * Gets the selected items from Finder.
- *
- * @throws An error when Finder is not the frontmost application.
- * @returns A Promise that resolves with the selected file system items.
- *
- * @example
- * ```typescript
- * import { getSelectedFinderItems, Clipboard, showToast, Toast } from "@raycast/api";
- *
- * export default async () => {
- *   try {
- *     const selectedItems = await getSelectedFinderItems();
- *     if (selectedItems.length) {
- *       await Clipboard.paste(selectedItems[0].path);
- *     }
- *   } catch (error) {
- *     await showToast({
- *       style: Toast.Style.Failure,
- *       title: "Cannot copy file path",
- *       message: String(error)
- *     });
- *   }
- * };
- * ```
- */
-export declare function getSelectedFinderItems(): Promise<FileSystemItem[]>;

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

@@ -1 +0,0 @@
-export * from "./useNavigation";

package/types/api/hooks/useNavigation.d.ts

@@ -1,66 +0,0 @@
-import { ReactNode } from "react";
-/**
- * Return type of the {@link useNavigation} hook to perform push and pop actions.
- */
-export interface Navigation {
-    /**
-     * Push a new view component to the navigation stack.
-     *
-     * @param component - The React component to push to the navigation stack.
-     */
-    push: (component: ReactNode) => void;
-    /**
-     * Pop current view component from the navigation stack.
-     */
-    pop: () => void;
-}
-/**
- * A hook that lets you push and pop view components in the navigation stack.
- *
- * @remarks
- * You most likely won't use this hook too often. To push a new component, use the {@link PushAction}.
- * When a user presses `ESC`, we automatically push to the previous component.
- *
- * @returns A {@link Navigation} object with {@link Navigation.push} and {@link Navigation.pop} functions.
- * Use the functions to alter the navigation stack.
- *
- * @example
- * ```typescript
- * import { ActionPanel, Detail, useNavigation, Action } from "@raycast/api";
- *
- * function Ping() {
- *   const { push } = useNavigation();
- *
- *   return (
- *     <Detail
- *       markdown="Ping"
- *       actions={
- *         <ActionPanel>
- *           <Action title="Push" onAction={() => push(<Pong />)} />
- *         </ActionPanel>
- *       }
- *     />
- *   );
- * }
- *
- * function Pong() {
- *   const { pop } = useNavigation();
- *
- *   return (
- *     <Detail
- *       markdown="Pong"
- *       actions={
- *         <ActionPanel>
- *           <Action title="Pop" onAction={pop} />
- *         </ActionPanel>
- *       }
- *     />
- *   );
- * }
- *
- * export default function Command() {
- *   return <Ping />;
- * }
- * ```
- */
-export declare function useNavigation(): Navigation;

package/types/api/index.d.ts

@@ -1,6 +0,0 @@
-export * from "./app";
-export * from "./components";
-export * from "./environment";
-export * from "./hooks";
-export * from "./ui";
-export * from "./deprecated";

package/types/api/internal/comm/index.d.ts

@@ -1 +0,0 @@
-export {};

package/types/api/internal/components/ErrorBoundary.d.ts

@@ -1 +0,0 @@
-export {};

package/types/api/internal/components/Navigation.d.ts

@@ -1 +0,0 @@
-export {};

package/types/api/internal/components/Root.d.ts

@@ -1 +0,0 @@
-export {};

package/types/api/internal/components/index.d.ts

@@ -1,3 +0,0 @@
-export * from "./ErrorBoundary";
-export * from "./Navigation";
-export * from "./Root";

package/types/api/internal/devtools/actionPanel.d.ts

@@ -1 +0,0 @@
-export {};

package/types/api/internal/devtools/index.d.ts

@@ -1,2 +0,0 @@
-export * from "./react";
-export * from "./actionPanel";

package/types/api/internal/devtools/react.d.ts

@@ -1 +0,0 @@
-export {};

package/types/api/internal/hooks/index.d.ts

@@ -1 +0,0 @@
-export * from "./useId";

package/types/api/internal/hooks/useId.d.ts

@@ -1 +0,0 @@
-export {};

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

@@ -1,6 +0,0 @@
-export * from "./comm";
-export * from "./components";
-export * from "./devtools";
-export * from "./hooks";
-export * from "./rendering";
-export * from "./utils";

package/types/api/internal/rendering/callbacks.d.ts

@@ -1 +0,0 @@
-export {};

package/types/api/internal/rendering/index.d.ts

@@ -1,6 +0,0 @@
-export * from "./renderer";
-export { apiCallbacks } from "./callbacks";
-export * from "./reconciler";
-export type { FormValueModel } from "./node-builders/forms";
-export { wrapImageIfNeeded } from "./node-builders/utils";
-export { specialKeys } from "./node-builders/keyboard";

package/types/api/internal/rendering/logger.d.ts

@@ -1,4 +0,0 @@
-export declare function reactRenderDebugLog(...params: unknown[]): void;
-export declare function reconcilerDebugLog(...params: unknown[]): void;
-export declare function benchmarkingStart(label?: string): void;
-export declare function benchmarkingStop(label?: string): void;

package/types/api/internal/rendering/node-builders/actions.d.ts

@@ -1,3 +0,0 @@
-import { RaycastElement } from "./types";
-export declare function appendActionPanelChildElement(actionPanelElement: RaycastElement, childElement: RaycastElement): void;
-export declare function appendActionPanelSubmenuChildElement(actionPanelElement: RaycastElement, childElement: RaycastElement): void;

package/types/api/internal/rendering/node-builders/detail.d.ts

@@ -1,2 +0,0 @@
-import { RaycastElement } from "./types";
-export declare function appendDetailChildElement(detailElement: RaycastElement, childElement: RaycastElement): void;

package/types/api/internal/rendering/node-builders/forms.d.ts

@@ -1,2 +0,0 @@
-import { RaycastElement } from "./types";
-export declare function appendFormChildElement(formElement: RaycastElement, childElement: RaycastElement): void;

package/types/api/internal/rendering/node-builders/keyboard.d.ts

@@ -1 +0,0 @@
-export {};

package/types/api/internal/rendering/node-builders/list.d.ts

@@ -1,4 +0,0 @@
-import { RaycastElement } from "./types";
-export declare function appendListChildElement(listElement: RaycastElement, childElement: RaycastElement): void;
-export declare function appendListDropdownChildElement(listElement: RaycastElement, childElement: RaycastElement): void;
-export declare function appendListItemChildElement(listItemElement: RaycastElement, childElement: RaycastElement): void;

package/types/api/internal/rendering/node-builders/navigationStack.d.ts

@@ -1 +0,0 @@
-export {};

package/types/api/internal/rendering/node-builders/root.d.ts

@@ -1 +0,0 @@
-export {};

package/types/api/internal/rendering/node-builders/types.d.ts

@@ -1 +0,0 @@
-export declare const AllPropsFromChildren: PropsFromChildren[];

package/types/api/internal/rendering/node-builders/utils.d.ts

@@ -1 +0,0 @@
-export {};

package/types/api/internal/rendering/reconciler/index.d.ts

@@ -1 +0,0 @@
-export {};

package/types/api/internal/rendering/reconciler/noHydratation.d.ts

@@ -1,37 +0,0 @@
-declare function shim(): any;
-export declare const supportsHydration = false;
-export declare const canHydrateInstance: typeof shim;
-export declare const canHydrateTextInstance: typeof shim;
-export declare const canHydrateSuspenseInstance: typeof shim;
-export declare const isSuspenseInstancePending: typeof shim;
-export declare const isSuspenseInstanceFallback: typeof shim;
-export declare const registerSuspenseInstanceRetry: typeof shim;
-export declare const getNextHydratableSibling: typeof shim;
-export declare const getFirstHydratableChild: typeof shim;
-export declare const getFirstHydratableChildWithinContainer: typeof shim;
-export declare const getFirstHydratableChildWithinSuspenseInstance: typeof shim;
-export declare const hydrateInstance: typeof shim;
-export declare const hydrateTextInstance: typeof shim;
-export declare const hydrateSuspenseInstance: typeof shim;
-export declare const getNextHydratableInstanceAfterSuspenseInstance: typeof shim;
-export declare const commitHydratedContainer: typeof shim;
-export declare const commitHydratedSuspenseInstance: typeof shim;
-export declare const clearSuspenseBoundary: typeof shim;
-export declare const clearSuspenseBoundaryFromContainer: typeof shim;
-export declare const shouldDeleteUnhydratedTailInstances: typeof shim;
-export declare const didNotMatchHydratedContainerTextInstance: typeof shim;
-export declare const didNotMatchHydratedTextInstance: typeof shim;
-export declare const didNotHydrateInstanceWithinContainer: typeof shim;
-export declare const didNotHydrateInstanceWithinSuspenseInstance: typeof shim;
-export declare const didNotHydrateInstance: typeof shim;
-export declare const didNotFindHydratableInstanceWithinContainer: typeof shim;
-export declare const didNotFindHydratableTextInstanceWithinContainer: typeof shim;
-export declare const didNotFindHydratableSuspenseInstanceWithinContainer: typeof shim;
-export declare const didNotFindHydratableInstanceWithinSuspenseInstance: typeof shim;
-export declare const didNotFindHydratableTextInstanceWithinSuspenseInstance: typeof shim;
-export declare const didNotFindHydratableSuspenseInstanceWithinSuspenseInstance: typeof shim;
-export declare const didNotFindHydratableInstance: typeof shim;
-export declare const didNotFindHydratableTextInstance: typeof shim;
-export declare const didNotFindHydratableSuspenseInstance: typeof shim;
-export declare const errorHydratingContainer: typeof shim;
-export {};

package/types/api/internal/rendering/reconciler/noMutation.d.ts

@@ -1,18 +0,0 @@
-declare function shim(): any;
-export declare const supportsMutation = false;
-export declare const appendChild: typeof shim;
-export declare const appendChildToContainer: typeof shim;
-export declare const commitTextUpdate: typeof shim;
-export declare const commitMount: typeof shim;
-export declare const commitUpdate: typeof shim;
-export declare const insertBefore: typeof shim;
-export declare const insertInContainerBefore: typeof shim;
-export declare const removeChild: typeof shim;
-export declare const removeChildFromContainer: typeof shim;
-export declare const resetTextContent: typeof shim;
-export declare const hideInstance: typeof shim;
-export declare const hideTextInstance: typeof shim;
-export declare const unhideInstance: typeof shim;
-export declare const unhideTextInstance: typeof shim;
-export declare const clearContainer: typeof shim;
-export {};

package/types/api/internal/rendering/renderer.d.ts

@@ -1 +0,0 @@
-export {};

package/types/api/internal/utils/ids.d.ts

@@ -1 +0,0 @@
-export {};

package/types/api/internal/utils/index.d.ts

@@ -1,3 +0,0 @@
-export * from "./ids";
-export * from "./internal-children";
-export * from "./propTypes";

package/types/api/internal/utils/internal-children.d.ts

@@ -1,26 +0,0 @@
-import { ReactNode } from "react";
-import { RaycastElement } from "../rendering/node-builders/types";
-/**
- * Users are expected to pass some components as props.
- * However, because internally we take that prop and pass it as a child (to go throught the react reconciler),
- * it means that a user could also pass the component as a child instead of using the prop.
- *
- * To circumvent this, in development mode we wrap the components passed as a prop with an `internal` flag context;
- *
- * Components that can be "internal" must listen to this context and pass it as a prop so that during
- * reconciliation, if the flag is falsy the component is not added to the render tree and a warning is printed.
- */
-export declare const InternalChildContext: import("react").Context<boolean>;
-/**
- * Method to wrap a component prop with the internal dev flag
- * @see {@link InternalChildContext}
- */
-export declare function propToInternalChild(prop?: ReactNode): {};
-/**
- * Check if the child has the internal flag set.
- * Output a warning otherwise.
- */
-export declare function internalChildInvariant(child: RaycastElement, warning: string): boolean;
-export declare type MaybeInternalComponent<T> = T & {
-    internal?: boolean;
-};

package/types/api/internal/utils/propTypes.d.ts

@@ -1,3 +0,0 @@
-declare function getPropType(propValue: unknown): "string" | "number" | "bigint" | "boolean" | "symbol" | "undefined" | "object" | "function" | "array";
-declare function getPreciseType(propValue: unknown): string;
-export { getPropType, getPreciseType };

package/types/api/ui/color.d.ts

@@ -1,115 +0,0 @@
-/**
- * The standard colors. Use those colors for consistency.
- *
- * @remarks
- * The colors automatically adapt to the Raycast theme (light or dark).
- *
- * @example
- * ```typescript
- * import { Color, Icon, List } from "@raycast/api";
- *
- * export default function Command() {
- *  return (
- *  <List>
- *    <List.Item title="Blue" icon={{ source: Icon.Circle, tintColor: Color.Blue }} />
- *    <List.Item title="Green" icon={{ source: Icon.Circle, tintColor: Color.Green }} />
- *    <List.Item title="Brown" icon={{ source: Icon.Circle, tintColor: Color.Brown }} />
- *    <List.Item title="Magenta" icon={{ source: Icon.Circle, tintColor: Color.Magenta }} />
- *    <List.Item title="Orange" icon={{ source: Icon.Circle, tintColor: Color.Orange }} />
- *    <List.Item title="Purple" icon={{ source: Icon.Circle, tintColor: Color.Purple }} />
- *    <List.Item title="Red" icon={{ source: Icon.Circle, tintColor: Color.Red }} />
- *    <List.Item title="Yellow" icon={{ source: Icon.Circle, tintColor: Color.Yellow }} />
- *    <List.Item title="PrimaryText" icon={{ source: Icon.Circle, tintColor: Color.PrimaryText }} />
- *    <List.Item title="SecondaryText" icon={{ source: Icon.Circle, tintColor: Color.SecondaryText }} />
- *  </List>
- *  );
- * };
- * ```
- */
-export declare enum Color {
-    Blue = "raycast-blue",
-    Brown = "raycast-brown",
-    Green = "raycast-green",
-    Magenta = "raycast-magenta",
-    Orange = "raycast-orange",
-    Purple = "raycast-purple",
-    Red = "raycast-red",
-    Yellow = "raycast-yellow",
-    PrimaryText = "raycast-primary-text",
-    SecondaryText = "raycast-secondary-text"
-}
-export declare namespace Color {
-    /**
-     * Union type for the supported color types.
-     *
-     * {@link Color.Raw} will be dynamically adjusted to achieve high contrast with the Raycast user interface.
-     *
-     * @example
-     * ```typescript
-     * import { Color, Icon, List } from "@raycast/api";
-     *
-     * export default function Command() {
-     *   return (
-     *     <List>
-     *       <List.Item title="Built-in color" icon={{ source: Icon.Circle, tintColor: Color.Red }} />
-     *       <List.Item title="HEX" icon={{ source: Icon.Circle, tintColor: "#FF0000" }} />
-     *       <List.Item title="Short HEX" icon={{ source: Icon.Circle, tintColor: "#F00" }} />
-     *       <List.Item title="RGBA" icon={{ source: Icon.Circle, tintColor: "rgb(255, 0, 0)" }} />
-     *       <List.Item title="RGBA Percentage" icon={{ source: Icon.Circle, tintColor: "rgb(255, 0, 0, 1.0)" }} />
-     *       <List.Item title="HSL" icon={{ source: Icon.Circle, tintColor: "hsla(200, 20%, 33%, 0.2)" }} />
-     *       <List.Item title="Keywords" icon={{ source: Icon.Circle, tintColor: "red" }} />
-     *     </List>
-     *   );
-     * };
-     * ```
-     */
-    type ColorLike = Color | Color.Dynamic | Color.Raw;
-    /**
-     * A dynamic color applies different colors depending on the active Raycast theme.
-     *
-     * @example
-     * ```typescript
-     * import { Color, Icon, List } from "@raycast/api";
-     *
-     * export default function Command() {
-     *  return (
-     *  <List>
-     *    <List.Item title="Dynamic Tint Color" icon={{ source: Icon.Circle, tintColor: { light: "#FF01FF", dark: "#FFFF50", adjustContrast: true } }} />
-     *    <List.Item title="Dynamic Tint Color" icon={{ source: Icon.Circle, tintColor: { light: "#FF01FF", dark: "#FFFF50" } }} />
-     *  </List>
-     *  );
-     * };
-     * ```
-     */
-    interface Dynamic {
-        /**
-         * The color which is used in light theme.
-         */
-        light: Color.Raw;
-        /**
-         * The color which is used in dark theme.
-         */
-        dark: Color.Raw;
-        /**
-         * Enables dynamic contrast adjustment for light and dark theme color.
-         *
-         * @remarks
-         * Colors different to the built-in {@link Color} can be dynamically adjusted to achieve high contrast with the
-         * Raycast user interface. This makes it easy to guarantee a good look and feel when you aren't in control of the
-         * color, e.g. get it via a network request.
-         *
-         * @defaultValue false
-         */
-        adjustContrast?: boolean;
-    }
-    /**
-     * You can use any of the following color formats:
-     * - HEX, e.g `#FF0000`
-     * - Short HEX, e.g. `#F00`
-     * - RGBA, e.g. `rgb(255, 0, 0)`
-     * - RGBA Percentage, e.g. `rgb(255, 0, 0, 1.0)`
-     * - HSL, e.g. `hsla(200, 20%, 33%, 0.2)`
-     * - Keywords, e.g. `red`
-     */
-    type Raw = string;
-}

package/types/api/ui/errors.d.ts

@@ -1 +0,0 @@
-export {};

package/types/api/ui/feedback/alert.d.ts

@@ -1,97 +0,0 @@
-import { Image } from "../image";
-/**
- * Creates and shows a confirmation Alert with the given options.
- *
- * @param options - The options used to create the Alert.
- * @returns A Promise that resolves to a boolean when the user triggers one of the actions.
- * It will be `true` for the primary Action, `false` for the dismiss Action.
- *
- * @example
- * ```typescript
- * import { confirmAlert } from "@raycast/api";
- *
- * export default async () => {
- *   if (await confirmAlert({ title: "Are you sure?" })) {
- *     // do something
- *   }
- * };
- * ```
- */
-export declare function confirmAlert(options: Alert.Options): Promise<boolean>;
-export declare namespace Alert {
-    /**
-     * The options to create an {@link Alert}.
-     *
-     * @example
-     * ```typescript
-     * import { confimrAlert, Alert } from "@raycast/api";
-     *
-     * export default async () => {
-     *   const options: Alert.Options = {
-     *     title: "Finished cooking",
-     *     message: "Delicious pasta for lunch",
-     *     primaryAction: {
-     *       title: 'Do something',
-     *       onAction: () => {
-     *         // while you can register a handler for an action, it's more elegant
-     *         // to use the `if (await confirmAlert(...)) { ... }` pattern
-     *         console.log("The alert action has been triggered")
-     *       }
-     *     }
-     *   };
-     *   await confirmAlert(options);
-     * };
-     * ```
-     */
-    interface Options {
-        /**
-         * The icon of an alert to illustrate the action. Displayed on the top.
-         */
-        icon?: Image.ImageLike;
-        /**
-         * The title of an alert. Displayed below the icon.
-         */
-        title: string;
-        /**
-         * An additional message for an Alert. Useful to show more information, e.g. a confirmation message for a destructive action.
-         */
-        message?: string;
-        /**
-         * The primary Action the user can take.
-         */
-        primaryAction?: ActionOptions;
-        /**
-         * The Action to dismiss the alert. There usually shouldn't be any side effects when the user takes this action.
-         */
-        dismissAction?: ActionOptions;
-    }
-    /**
-     * The options to create an {@link Alert} Action.
-     */
-    interface ActionOptions {
-        /**
-         * The title of the action.
-         */
-        title: string;
-        /**
-         * The style of the action.
-         */
-        style?: ActionStyle;
-        /**
-         * A callback called when the action is triggered.
-         */
-        onAction?: () => void;
-    }
-    /**
-     * Defines the visual style of an Action of the Alert.
-     *
-     * @remarks
-     * Use {@link Alert.ActionStyle.Default} for confirmations of a positive action.
-     * Use {@link Alert.ActionStyle.Destructive} for confirmations of a destructive action (eg. deleting a file).
-     */
-    enum ActionStyle {
-        Default = "DEFAULT",
-        Cancel = "CANCEL",
-        Destructive = "DESTRUCTIVE"
-    }
-}