@raycast/api 1.38.0 → 1.38.3

package/api.d.ts

@@ -126,8 +126,9 @@ export declare namespace Action {
  * 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
+ * In {@link List}, {@link Grid}, 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.
+ * Keep in mind that while you can specify an alternative shortcut for the primary and secondary actions, it won't be displayed in the Action Panel.
  *
  * @example
  * ```typescript
@@ -198,9 +199,7 @@ declare type ActionPanelChildren_2 = ReactElement<ActionPanel.Section.Props> | R
  * @deprecated Use {@link Action} instead.
  */
 export declare const ActionPanelItem: FunctionComponent<ActionProps> & ConvenienceActions & {
-    Style: ActionStyle; /**
-    * @deprecated Use {@link Image.ImageLike} instead
-    */
+    Style: ActionStyle;
 };
 
 /**
@@ -382,7 +381,8 @@ declare interface ActionProps {
      *
      * @remarks
      * The first and second action in an {@link ActionPanel} 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.
+     * In {@link List}, {@link Grid} ,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.
+     * Keep in mind that while you can specify an alternative shortcut for the primary and secondary actions, it won't be displayed in the Action Panel.
      */
     shortcut?: Keyboard.Shortcut | undefined | null;
     /**
@@ -537,7 +537,6 @@ export declare interface Application {
 }
 
 /**
- * @beta
  * A record type holding the arguments (entered in Raycast Root Search Bar) that have been passed to the command.
  */
 declare interface Arguments {
@@ -548,7 +547,6 @@ declare interface Arguments {
 }
 
 /**
- * @beta
  * An interface describing top-level props for arguments
  */
 export declare interface ArgumentsLaunchProps {
@@ -2131,7 +2129,6 @@ export declare interface Environment {
      */
     theme: "light" | "dark";
     /**
-     * @beta
      * The type of launch for the command (user initiated or background).
      */
     launchType: LaunchType;
@@ -3915,7 +3912,7 @@ declare interface GridMembers {
      * export default function Command() {
      *   return (
      *     <Grid>
-     *       <Grid.Item icon={Icon.Star} title="Augustiner Helles" subtitle="0,5 Liter" />
+     *       <Grid.Item content={Icon.Star} title="Augustiner Helles" subtitle="0,5 Liter" />
      *     </Grid>
      *   );
      * }
@@ -4281,8 +4278,16 @@ export declare enum Icon {
     Network = "network-16",
     NewDocument = "new-document-16",
     NewFolder = "new-folder-16",
-    Number = "number-01-16",
     Number00 = "number-00-16",
+    Number01 = "number-01-16",
+    Number02 = "number-02-16",
+    Number03 = "number-03-16",
+    Number04 = "number-04-16",
+    Number05 = "number-05-16",
+    Number06 = "number-06-16",
+    Number07 = "number-07-16",
+    Number08 = "number-08-16",
+    Number09 = "number-09-16",
     Number10 = "number-10-16",
     Number11 = "number-11-16",
     Number12 = "number-12-16",
@@ -4489,7 +4494,9 @@ export declare enum Icon {
     /** @deprecated Use {@link Icon.SpeakerOff} instead. */
     SpeakerSlash = "speaker-off-16",
     /** @deprecated Use {@link Icon.BlankDocument} instead. */
-    TextDocument = "blank-document-16"
+    TextDocument = "blank-document-16",
+    /** @deprecated Use {@link Icon.XMarkCircle} instead. */
+    XmarkCircle = "x-mark-circle-16"
 }
 
 /**
@@ -4684,7 +4691,6 @@ declare const Item: FunctionComponent<ItemProps> & ItemMembers;
 declare const Item_2: FunctionComponent<ItemProps_2>;
 
 /**
- * @beta
  * See {@link MenuBarExtra.Item}
  */
 declare const Item_3: FunctionComponent<ItemProps_3>;
@@ -4846,14 +4852,26 @@ declare interface ItemProps_2 extends ActionsInterface {
     actions?: ReactNode | null;
 }
 
-/**
- * @beta
- */
 declare interface ItemProps_3 {
+    /**
+     * The main title displayed for this item.
+     */
     title: string;
+    /**
+     * An optional icon for this item.
+     */
     icon?: Image.ImageLike;
+    /**
+     * A tooltip to display when the cursor hovers the item.
+     */
     tooltip?: string;
+    /**
+     * An action handler called when the user clicks the item.
+     */
     onAction?: () => void;
+    /**
+     * A shortcut used to invoke this item when its parent menu is open.
+     */
     shortcut?: Keyboard.Shortcut;
 }
 
@@ -4973,14 +4991,10 @@ declare interface LabelProps_2 {
 }
 
 /**
- * @beta
  * The top-level props that a Command receives on launch
  */
 export declare type LaunchProps = ArgumentsLaunchProps | FormLaunchProps;
 
-/**
- * @beta
- */
 export declare enum LaunchType {
     /**
      * A regular launch through user interaction
@@ -5484,38 +5498,39 @@ export declare type LocalStorageValue = LocalStorage.Value;
 export declare interface LocalStorageValues extends LocalStorage.Values {
 }
 
-/**
- * @beta
- */
 export declare const MenuBarExtra: FunctionComponent<MenuBarExtraProps> & MenuBarExtraMembers;
 
-/**
- * @beta
- */
 export declare namespace MenuBarExtra {
     export type Props = MenuBarExtraProps;
 }
 
-/**
- * @beta
- */
 declare interface MenuBarExtraMembers {
     Item: typeof Item_3;
     Separator: typeof Separator_4;
     Submenu: typeof Submenu_2;
 }
 
-/**
- * @beta
- */
 declare interface MenuBarExtraProps {
     /**
+     * Indicates to Raycast that it should not unload the command, as it is still executing. If you set make use of `isLoading`, you need to make sure you set it to `false` at the end of the task you are executing (such as an API call), so Raycast can then unload the command.
      * @defaultValue `false`
      */
     isLoading?: boolean;
+    /**
+     * The string that is displayed in the menu bar.
+     */
     title?: string;
+    /**
+     * A tooltip to display when the cursor hovers the item in the menu bar.
+     */
     tooltip?: string;
+    /**
+     * The icon that is displayed in the menu bar.
+     */
     icon?: Image.ImageLike;
+    /**
+     * `MenuBarExtra.Item`s, `MenuBarExtra.Submenu`s, `MenuBarExtra.Separator` or a mix of either.
+     */
     children?: ReactNode;
 }
 
@@ -6482,7 +6497,6 @@ declare const Separator_2: FunctionComponent<SeparatorProps_2>;
 declare const Separator_3: FunctionComponent<SeparatorProps_3>;
 
 /**
- * @beta
  * See {@link MenuBarExtra.Separator}
  */
 declare const Separator_4: FunctionComponent<SeparatorProps_4>;
@@ -6499,9 +6513,6 @@ declare interface SeparatorProps_2 {
 declare interface SeparatorProps_3 {
 }
 
-/**
- * @beta
- */
 declare interface SeparatorProps_4 {
 }
 
@@ -6667,7 +6678,6 @@ export declare const specialKeys: any;
 declare const Submenu: FunctionComponent<SubmenuProps>;
 
 /**
- * @beta
  * See {@link MenuBarExtra.Submenu}
  */
 declare const Submenu_2: FunctionComponent<SubmenuProps_2>;
@@ -6729,15 +6739,18 @@ declare interface SubmenuProps {
     onOpen?: () => void;
 }
 
-/**
- * @beta
- */
 declare interface SubmenuProps_2 {
-    title: string | {
-        value: string;
-        tooltip: string;
-    };
+    /**
+     * The main title displayed for this submenu.
+     */
+    title: string;
+    /**
+     * An optional icon for this submenu.
+     */
     icon?: Image.ImageLike;
+    /**
+     * `MenuBarExtra.Item`s, `MenuBarExtra.Submenu`s, `MenuBarExtra.Separator` or a mix of either.
+     */
     children?: ReactNode;
 }
 
@@ -7211,7 +7224,6 @@ declare interface TrashProps {
 }
 
 /**
- * @beta
  * Update the values of properties declared in the manifest of a command.
  *
  * @param metadata - An object with the values for the manifest properties to update.

package/bin/ray

@@ -1,4 +1,4 @@
-#!/usr/bin/env bash
+#!/bin/bash
 
 DIR=$(dirname "${BASH_SOURCE[0]}")
 SYMLINK=$(readlink "${BASH_SOURCE[0]}")

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@raycast/api",
-  "version": "1.38.0",
+  "version": "1.38.3",
   "description": "Build extensions for Raycast with React and Node.js.",
   "author": "Raycast Technologies Ltd.",
   "homepage": "https://developers.raycast.com",

package/types/index.d.ts

@@ -126,8 +126,9 @@ export declare namespace Action {
  * 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
+ * In {@link List}, {@link Grid}, 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.
+ * Keep in mind that while you can specify an alternative shortcut for the primary and secondary actions, it won't be displayed in the Action Panel.
  *
  * @example
  * ```typescript
@@ -198,9 +199,7 @@ declare type ActionPanelChildren_2 = ReactElement<ActionPanel.Section.Props> | R
  * @deprecated Use {@link Action} instead.
  */
 export declare const ActionPanelItem: FunctionComponent<ActionProps> & ConvenienceActions & {
-    Style: ActionStyle; /**
-    * @deprecated Use {@link Image.ImageLike} instead
-    */
+    Style: ActionStyle;
 };
 
 /**
@@ -382,7 +381,8 @@ declare interface ActionProps {
      *
      * @remarks
      * The first and second action in an {@link ActionPanel} 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.
+     * In {@link List}, {@link Grid} ,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.
+     * Keep in mind that while you can specify an alternative shortcut for the primary and secondary actions, it won't be displayed in the Action Panel.
      */
     shortcut?: Keyboard.Shortcut | undefined | null;
     /**
@@ -536,6 +536,26 @@ export declare interface Application {
     bundleId?: string;
 }
 
+/**
+ * A record type holding the arguments (entered in Raycast Root Search Bar) that have been passed to the command.
+ */
+declare interface Arguments {
+    /**
+     * The representation of arguments given that key here is the `name` defined in manifest file and value is the user's input
+     */
+    [item: string]: any;
+}
+
+/**
+ * An interface describing top-level props for arguments
+ */
+export declare interface ArgumentsLaunchProps {
+    /**
+     * Use these values to populate the initial state for your command.
+     */
+    arguments?: Arguments;
+}
+
 /**
  * Caching abstraction that stores data on disk and supports LRU (least recently used) access.
  * Since extensions can only consume up to a max. heap memory size, the cache only maintains a lightweight index in memory
@@ -2108,7 +2128,10 @@ export declare interface Environment {
      * The theme used by the Raycast application.
      */
     theme: "light" | "dark";
-
+    /**
+     * The type of launch for the command (user initiated or background).
+     */
+    launchType: LaunchType;
 }
 
 /**
@@ -3889,7 +3912,7 @@ declare interface GridMembers {
      * export default function Command() {
      *   return (
      *     <Grid>
-     *       <Grid.Item icon={Icon.Star} title="Augustiner Helles" subtitle="0,5 Liter" />
+     *       <Grid.Item content={Icon.Star} title="Augustiner Helles" subtitle="0,5 Liter" />
      *     </Grid>
      *   );
      * }
@@ -4255,8 +4278,16 @@ export declare enum Icon {
     Network = "network-16",
     NewDocument = "new-document-16",
     NewFolder = "new-folder-16",
-    Number = "number-01-16",
     Number00 = "number-00-16",
+    Number01 = "number-01-16",
+    Number02 = "number-02-16",
+    Number03 = "number-03-16",
+    Number04 = "number-04-16",
+    Number05 = "number-05-16",
+    Number06 = "number-06-16",
+    Number07 = "number-07-16",
+    Number08 = "number-08-16",
+    Number09 = "number-09-16",
     Number10 = "number-10-16",
     Number11 = "number-11-16",
     Number12 = "number-12-16",
@@ -4463,7 +4494,9 @@ export declare enum Icon {
     /** @deprecated Use {@link Icon.SpeakerOff} instead. */
     SpeakerSlash = "speaker-off-16",
     /** @deprecated Use {@link Icon.BlankDocument} instead. */
-    TextDocument = "blank-document-16"
+    TextDocument = "blank-document-16",
+    /** @deprecated Use {@link Icon.XMarkCircle} instead. */
+    XmarkCircle = "x-mark-circle-16"
 }
 
 /**
@@ -4657,6 +4690,11 @@ declare const Item: FunctionComponent<ItemProps> & ItemMembers;
  */
 declare const Item_2: FunctionComponent<ItemProps_2>;
 
+/**
+ * See {@link MenuBarExtra.Item}
+ */
+declare const Item_3: FunctionComponent<ItemProps_3>;
+
 declare type ItemAccessory = ({
     /**
      * An optional text that will be used as the label.
@@ -4814,6 +4852,29 @@ declare interface ItemProps_2 extends ActionsInterface {
     actions?: ReactNode | null;
 }
 
+declare interface ItemProps_3 {
+    /**
+     * The main title displayed for this item.
+     */
+    title: string;
+    /**
+     * An optional icon for this item.
+     */
+    icon?: Image.ImageLike;
+    /**
+     * A tooltip to display when the cursor hovers the item.
+     */
+    tooltip?: string;
+    /**
+     * An action handler called when the user clicks the item.
+     */
+    onAction?: () => void;
+    /**
+     * A shortcut used to invoke this item when its parent menu is open.
+     */
+    shortcut?: Keyboard.Shortcut;
+}
+
 export declare namespace Keyboard {
     /**
      * A keyboard shortcut is defined by one or more modifier keys (command, control, etc.) and a single key equivalent (a character or special key).
@@ -4929,6 +4990,22 @@ declare interface LabelProps_2 {
     text?: string;
 }
 
+/**
+ * The top-level props that a Command receives on launch
+ */
+export declare type LaunchProps = ArgumentsLaunchProps | FormLaunchProps;
+
+export declare enum LaunchType {
+    /**
+     * A regular launch through user interaction
+     */
+    UserInitiated = "userInitiated",
+    /**
+     * Scheduled through an interval and launched from background
+     */
+    Background = "background"
+}
+
 /**
  * See {@link Detail.Metadata.Link}
  */
@@ -5421,6 +5498,42 @@ export declare type LocalStorageValue = LocalStorage.Value;
 export declare interface LocalStorageValues extends LocalStorage.Values {
 }
 
+export declare const MenuBarExtra: FunctionComponent<MenuBarExtraProps> & MenuBarExtraMembers;
+
+export declare namespace MenuBarExtra {
+    export type Props = MenuBarExtraProps;
+}
+
+declare interface MenuBarExtraMembers {
+    Item: typeof Item_3;
+    Separator: typeof Separator_4;
+    Submenu: typeof Submenu_2;
+}
+
+declare interface MenuBarExtraProps {
+    /**
+     * Indicates to Raycast that it should not unload the command, as it is still executing. If you set make use of `isLoading`, you need to make sure you set it to `false` at the end of the task you are executing (such as an API call), so Raycast can then unload the command.
+     * @defaultValue `false`
+     */
+    isLoading?: boolean;
+    /**
+     * The string that is displayed in the menu bar.
+     */
+    title?: string;
+    /**
+     * A tooltip to display when the cursor hovers the item in the menu bar.
+     */
+    tooltip?: string;
+    /**
+     * The icon that is displayed in the menu bar.
+     */
+    icon?: Image.ImageLike;
+    /**
+     * `MenuBarExtra.Item`s, `MenuBarExtra.Submenu`s, `MenuBarExtra.Separator` or a mix of either.
+     */
+    children?: ReactNode;
+}
+
 /**
  * See {@link Detail.Metadata}
  */
@@ -6383,6 +6496,11 @@ declare const Separator_2: FunctionComponent<SeparatorProps_2>;
  */
 declare const Separator_3: FunctionComponent<SeparatorProps_3>;
 
+/**
+ * See {@link MenuBarExtra.Separator}
+ */
+declare const Separator_4: FunctionComponent<SeparatorProps_4>;
+
 /**
  * See {@link Form.Separator.Props}
  */
@@ -6395,6 +6513,9 @@ declare interface SeparatorProps_2 {
 declare interface SeparatorProps_3 {
 }
 
+declare interface SeparatorProps_4 {
+}
+
 /**
  * @deprecated Use {@link LocalStorage.setItem} instead
  */
@@ -6556,6 +6677,11 @@ export declare const specialKeys: any;
  */
 declare const Submenu: FunctionComponent<SubmenuProps>;
 
+/**
+ * See {@link MenuBarExtra.Submenu}
+ */
+declare const Submenu_2: FunctionComponent<SubmenuProps_2>;
+
 declare type SubmenuChildren = ReactElement<SectionProps> | ReactElement<SectionProps>[] | SectionChildren | null;
 
 /**
@@ -6613,6 +6739,21 @@ declare interface SubmenuProps {
     onOpen?: () => void;
 }
 
+declare interface SubmenuProps_2 {
+    /**
+     * The main title displayed for this submenu.
+     */
+    title: string;
+    /**
+     * An optional icon for this submenu.
+     */
+    icon?: Image.ImageLike;
+    /**
+     * `MenuBarExtra.Item`s, `MenuBarExtra.Submenu`s, `MenuBarExtra.Separator` or a mix of either.
+     */
+    children?: ReactNode;
+}
+
 /**
  * See {@link Action.SubmitForm.Props}
  */
@@ -7082,6 +7223,28 @@ declare interface TrashProps {
     onTrash?: (paths: PathLike | PathLike[]) => void;
 }
 
+/**
+ * Update the values of properties declared in the manifest of a command.
+ *
+ * @param metadata - An object with the values for the manifest properties to update.
+ * Note that currently only `subtitle` is supported. Pass `null` to clear the custom subtitle.
+ * @returns A Promise that resolves when the metadata has been updated.
+ *
+ * @example
+ * ```typescript
+ * import { open } from "@raycast/api";
+ *
+ * export default async () => {
+ *   await updateCommandMetadata({ subtitle: "My new subtitle" });
+ * };
+ * ```
+ * @remarks The actual manifest file is not modified, so the update applies as
+ * long as the command remains installed.
+ */
+export declare function updateCommandMetadata(metadata: {
+    subtitle?: string | null;
+}): Promise<void>;
+
 /**
  * @deprecated No alternative :(
  */