@raycast/api 1.46.0 → 1.47.0

package/api.d.ts

@@ -770,6 +770,24 @@ export declare namespace Clipboard {
      * ```
      */
     export function paste(content: string | number | Content): Promise<void>;
+    /**
+     * Reads the clipboard content as plain text, file name, or HTML.
+     *
+     * @returns A Promise that resolves when the clipboard content was read.
+     *
+     * @example
+     * ```typescript
+     * import { Clipboard } from "@raycast/api";
+     *
+     * export default async () => {
+     *   const { text, file, html } = await Clipboard.read();
+     *   console.log(text);
+     *   console.log(file);
+     *   console.log(html);
+     * };
+     * ```
+     */
+    export function read(): Promise<ReadContent>;
     /**
      * Reads the clipboard as plain text.
      *
@@ -786,6 +804,25 @@ export declare namespace Clipboard {
      * ```
      */
     export function readText(): Promise<string | undefined>;
+    /**
+     * Type of the content read from the {@link Clipboard}.
+     *
+     * @example
+     * ```typescript
+     * import { Clipboard } from "@raycast/api";
+     *
+     * const content: Clipboard.ReadContent = {
+     *  text: "filename.pdf",
+     *  file: "/path/to/filename.pdf",
+     *  html: "<a href='/path/to/filename.pdf'>filename.pdf</p>",
+     * }
+     * ```
+     */
+    export type ReadContent = {
+        text: string;
+        file?: string;
+        html?: string;
+    };
     /**
      * Type of the content copied and pasted to and from the {@link Clipboard}.
      *
@@ -4944,7 +4981,7 @@ declare type ItemAccessory = ({
      */
     tag: string | Date | undefined | null | {
         value: string | Date | undefined | null;
-        color?: Color;
+        color?: Color.ColorLike;
     };
 }) & {
     /**
@@ -5248,7 +5285,7 @@ declare interface LabelProps {
 }
 
 /**
- * Launches another command of the same extension.
+ * Launches another command of the same extension. If the command does not exist, or if it's not enabled, an error will be thrown.
  * Use this method if your command needs to open another command based on user interaction,
  * or when an immediate background refresh should be triggered, for example when a command needs to update an associated menu-bar command.
  *
@@ -5259,6 +5296,8 @@ declare interface LabelProps {
  * `context`: arbitrary object for custom data that should be passed to the command and accessible as `environment.launchContext`; the object must be JSON serializable (Dates and Buffers supported)
  * @returns A Promise that resolves when the command has been launched. (Note that this does not indicate that the launched command has finished executing.)
  *
+ * @throws {@link Error} if the command does not exist or is not enabled.
+ *
  * @example
  * ```typescript
  * import { launchCommand, LaunchType } from "@raycast/api";

package/package.json

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

package/types/index.d.ts

@@ -766,6 +766,24 @@ export declare namespace Clipboard {
      * ```
      */
     export function paste(content: string | number | Content): Promise<void>;
+    /**
+     * Reads the clipboard content as plain text, file name, or HTML.
+     *
+     * @returns A Promise that resolves when the clipboard content was read.
+     *
+     * @example
+     * ```typescript
+     * import { Clipboard } from "@raycast/api";
+     *
+     * export default async () => {
+     *   const { text, file, html } = await Clipboard.read();
+     *   console.log(text);
+     *   console.log(file);
+     *   console.log(html);
+     * };
+     * ```
+     */
+    export function read(): Promise<ReadContent>;
     /**
      * Reads the clipboard as plain text.
      *
@@ -782,6 +800,25 @@ export declare namespace Clipboard {
      * ```
      */
     export function readText(): Promise<string | undefined>;
+    /**
+     * Type of the content read from the {@link Clipboard}.
+     *
+     * @example
+     * ```typescript
+     * import { Clipboard } from "@raycast/api";
+     *
+     * const content: Clipboard.ReadContent = {
+     *  text: "filename.pdf",
+     *  file: "/path/to/filename.pdf",
+     *  html: "<a href='/path/to/filename.pdf'>filename.pdf</p>",
+     * }
+     * ```
+     */
+    export type ReadContent = {
+        text: string;
+        file?: string;
+        html?: string;
+    };
     /**
      * Type of the content copied and pasted to and from the {@link Clipboard}.
      *
@@ -4940,7 +4977,7 @@ declare type ItemAccessory = ({
      */
     tag: string | Date | undefined | null | {
         value: string | Date | undefined | null;
-        color?: Color;
+        color?: Color.ColorLike;
     };
 }) & {
     /**
@@ -5244,7 +5281,7 @@ declare interface LabelProps {
 }
 
 /**
- * Launches another command of the same extension.
+ * Launches another command of the same extension. If the command does not exist, or if it's not enabled, an error will be thrown.
  * Use this method if your command needs to open another command based on user interaction,
  * or when an immediate background refresh should be triggered, for example when a command needs to update an associated menu-bar command.
  *
@@ -5255,6 +5292,8 @@ declare interface LabelProps {
  * `context`: arbitrary object for custom data that should be passed to the command and accessible as `environment.launchContext`; the object must be JSON serializable (Dates and Buffers supported)
  * @returns A Promise that resolves when the command has been launched. (Note that this does not indicate that the launched command has finished executing.)
  *
+ * @throws {@link Error} if the command does not exist or is not enabled.
+ *
  * @example
  * ```typescript
  * import { launchCommand, LaunchType } from "@raycast/api";