@raycast/api 1.28.0 → 1.29.0

package/package.json

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

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

@@ -8,7 +8,7 @@ import { Action } from "./actions";
  *
  * @remarks
  * Often items are context-aware, e.g. based on the selected list item. Actions can be grouped into semantic
- * section and can have keyboard shortcuts assigned.
+ * 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
@@ -76,7 +76,7 @@ declare namespace ActionPanelSubmenu {
              *
              * @remarks
              * Often items are context-aware, e.g. based on the selected list item. Actions can be grouped into semantic
-             * section and can have keyboard shortcuts assigned.
+             * 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
@@ -134,7 +134,7 @@ export declare namespace ActionPanel {
      * A group of visually separated items.
      *
      * @remarks
-     * Use sections if the {@link ActionPanel} contains a lot of actions to help guide the user to related actions.
+     * 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

package/types/api/components/actions/Action.d.ts

@@ -3,6 +3,8 @@ import PropTypes from "prop-types";
 import { Keyboard } from "../../app";
 import { Image } from "../../ui";
 import { CopyToClipboardAction, CopyToClipboardActionProps } from "./CopyToClipboardAction";
+import { CreateQuicklinkAction, CreateQuicklinkProps } from "./CreateQuicklinkAction";
+import { CreateSnippetAction, CreateSnippetProps } from "./CreateSnippetAction";
 import { OpenAction, OpenActionProps } from "./OpenAction";
 import { OpenInBrowserAction, OpenInBrowserActionProps } from "./OpenInBrowserAction";
 import { OpenWithAction, OpenWithActionProps } from "./OpenWithAction";
@@ -311,6 +313,50 @@ export declare namespace Action {
      * ```
      */
     const Trash: typeof TrashAction;
+    /**
+     * Action that navigates to the the Create Snippet command with some or all of the fields prefilled.
+     *
+     * @example
+     * ```typescript
+     * import { ActionPanel, Detail, Action } from "@raycast/api";
+     *
+     * export default function Command() {
+     *   return (
+     *     <Detail
+     *       markdown="Test out snippet creation"
+     *       actions={
+     *         <ActionPanel>
+     *           <Action.CreateSnippet snippet={{ text: "DE75512108001245126199" }} />
+     *         </ActionPanel>
+     *       }
+     *     />
+     *   );
+     * }
+     * ```
+     */
+    const CreateSnippet: typeof CreateSnippetAction;
+    /**
+     * Action that navigates to the the Create Quicklink command with some or all of the fields prefilled.
+     *
+     * @example
+     * ```typescript
+     * import { ActionPanel, Detail, Action } from "@raycast/api";
+     *
+     * export default function Command() {
+     *   return (
+     *     <Detail
+     *       markdown="Test out quicklink creation"
+     *       actions={
+     *         <ActionPanel>
+     *           <Action.CreateQuicklink quicklink={{ link: "https://duckduckgo.com/?q={Query}" }} />
+     *         </ActionPanel>
+     *       }
+     *     />
+     *   );
+     * }
+     * ```
+     */
+    const CreateQuicklink: typeof CreateQuicklinkAction;
     /**
      * Props of the {@link Action} React component.
      */
@@ -339,6 +385,18 @@ export declare namespace Action {
          */
         onAction?: () => void;
     }
+    namespace CreateQuicklink {
+        /**
+         * Props of the {@link Action.CreateQuicklink} React component.
+         */
+        type Props = CreateQuicklinkProps;
+    }
+    namespace CreateSnippet {
+        /**
+         * Props of the {@link Action.CreateSnippet} React component.
+         */
+        type Props = CreateSnippetProps;
+    }
     namespace CopyToClipboard {
         /**
          * Props of the {@link Action.CopyToClipboard} React component.

package/types/api/components/actions/CopyToClipboardAction.d.ts

@@ -11,6 +11,7 @@ export interface CopyToClipboardActionProps {
     content: string | number;
     /**
      * An optional title for the action.
+     * @defaultValue Copy to Clipboard
      */
     title?: string;
     /**

package/types/api/components/actions/CreateQuicklinkAction.d.ts

@@ -0,0 +1,42 @@
+import { ReactElement } from "react";
+import { Image } from "../../ui";
+import { Application, Keyboard } from "../../app";
+export interface Quicklink {
+    /**
+     * The URL or file path, optionally including placeholders such as in "https://google.com/search?q={Query}"
+     */
+    link: string;
+    /**
+     * The quicklink name
+     */
+    name?: string;
+    /**
+     * The application that the quicklink should be opened in.
+     */
+    application?: string | Application;
+}
+export interface CreateQuicklinkProps {
+    /**
+     * The {@link Quicklink} to create.
+     */
+    quicklink: Quicklink;
+    /**
+     * An optional title for the action.
+     */
+    title?: string;
+    /**
+     * A optional icon displayed for the item. See {@link ImageLike} for the supported formats and types.
+     */
+    icon?: Image.ImageLike;
+    /**
+     * The keyboard shortcut for the action.
+     */
+    shortcut?: Keyboard.Shortcut;
+}
+/**
+ * See {@link Action.CreateQuicklink}
+ */
+export declare function CreateQuicklinkAction(props: CreateQuicklinkProps): ReactElement<CreateQuicklinkProps>;
+export declare namespace CreateQuicklinkAction {
+    var displayName: string;
+}

package/types/api/components/actions/CreateSnippetAction.d.ts

@@ -0,0 +1,40 @@
+import { ReactElement } from "react";
+import { Image } from "../../ui";
+import { Keyboard } from "../../app";
+interface Snippet {
+    /**
+     * The snippet contents.
+     */
+    text: string;
+    /**
+     * The snippet name.
+     */
+    name?: string;
+    /**
+     * The keyword to trigger the snippet.
+     */
+    keyword?: string;
+}
+export interface CreateSnippetProps {
+    snippet: Snippet;
+    /**
+     * An optional title for the action.
+     */
+    title?: string;
+    /**
+     * A optional icon displayed for the item. See {@link ImageLike} for the supported formats and types.
+     */
+    icon?: Image.ImageLike;
+    /**
+     * The keyboard shortcut for the action.
+     */
+    shortcut?: Keyboard.Shortcut;
+}
+/**
+ * See {@link Action.CreateQuicklink}
+ */
+export declare function CreateSnippetAction(props: CreateSnippetProps): ReactElement<CreateSnippetProps>;
+export declare namespace CreateSnippetAction {
+    var displayName: string;
+}
+export {};

package/types/api/components/actions/OpenInBrowserAction.d.ts

@@ -11,6 +11,7 @@ export interface OpenInBrowserActionProps {
     url: string;
     /**
      * An optional title for the action.
+     * @defaultValue Open in Browser
      */
     title?: string;
     /**

package/types/api/components/actions/PasteAction.d.ts

@@ -11,6 +11,7 @@ export interface PasteActionProps {
     content: string | number;
     /**
      * An optional title for the action.
+     * @defaultValue Paste in Active app
      */
     title?: string;
     /**

package/types/api/components/actions/SubmitFormAction.d.ts

@@ -8,6 +8,7 @@ import type { Form } from "../Form";
 export interface SubmitFormActionProps<Values> {
     /**
      * The title displayed for the item.
+     * @defaultValue Submit Form
      */
     title?: string;
     /**

package/types/api/deprecated.d.ts

@@ -53,7 +53,7 @@ export interface LocalStorageValues extends LocalStorage.Values {
 export interface KeyboardShortcut extends Keyboard.Shortcut {
 }
 /**
- * @deprecated Use `Keyboard.specialKeys` instead
+ * @deprecated
  */
 export declare const specialKeys: Record<string, string>;
 /**

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

@@ -3,3 +3,4 @@ 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

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

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

@@ -1 +1,3 @@
-export {};
+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/list.d.ts

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

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

@@ -3,7 +3,7 @@ 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 takes an action.
+ * @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

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

@@ -1,7 +1,7 @@
 /**
  * A HUD will automatically hide the main window and show a compact message at the bottom of the screen.
  *
- * @param title - The title that will be displayed for the HUD.
+ * @param title - The title that will be displayed in the HUD.
  * @returns A Promise that resolves when the HUD is shown.
  *
  * @example

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

@@ -29,14 +29,17 @@ import { Keyboard } from "../../app";
  * export default async () => {
  *   const toast = await showToast({ style: Toast.Style.Animated, title: "Uploading image" });
  *
- *   await setTimeout(1000);
- *
- *   toast.style = ToastStyle.Success;
- *   toast.title = "Uploaded image";
- *
- *   await setTimeout(500);
+ *   try {
+ *    // upload the image
+ *    await setTimeout(1000);
  *
- *   await toast.hide()
+ *    toast.style = Toast.Style.Success;
+ *    toast.title = "Uploaded image";
+ *  } catch (err) {
+ *    toast.style = Toast.Style.Failure;
+ *    toast.title = "Failed to upload image";
+ *    toast.message = err.message;
+ *  }
  * };
  * ```
  */

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

@@ -103,7 +103,8 @@ export declare namespace Image {
         dark: URL | Asset;
     };
     /**
-     * Fallback {@link Image} source. Can be a local file resource, a built-in {@link Icon} or a single emoji.
+     * Fallback {@link Image} source. Can be a local file resource, a built-in {@link Icon}, a single emoji, or a theme-aware asset.
+     * Any specified `mask` or `tintColor` will also apply to the fallback image.
      *
      * @example
      * ```typescript