@raycast/api 1.72.1 → 1.73.1

package/package.json

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

package/types/index.d.ts

@@ -437,6 +437,9 @@ export declare namespace AI {
     /**
      * Returns a prompt completion.
      *
+     * @param prompt - The prompt to ask the AI.
+     * @param options - Options to control which and how the AI model should behave.
+     *
      * @example
      * ```typescript
      * import { Detail, AI, LaunchProps } from "@raycast/api";
@@ -652,9 +655,9 @@ export declare interface ArgumentsLaunchProps {
 export declare namespace BrowserExtension {
 
     /**
-     * Get the content of the active tab.
-     *
-     * @returns A Promise that resolves with the content.
+     * Get the content of an opened tab.
+     * @param options - Options to control which content to get.
+     * @returns A Promise that resolves with the content of the tab.
      *
      * @example
      * ```typescript
@@ -666,8 +669,7 @@ export declare namespace BrowserExtension {
      * };
      * ```
      */
-    export function getContent(options?: GetContentOptions): Promise<string>;
-    export type GetContentOptions = {
+    export function getContent(options?: {
         /**
          * The format of the content.
          *
@@ -691,7 +693,7 @@ export declare namespace BrowserExtension {
          * The ID of the tab to get the content from. If not specified, the content of the active tab of the focused window is returned.
          */
         tabId?: number;
-    };
+    }): Promise<string>;
     export interface Tab {
         /**
          * The ID of the tab. Tab IDs are unique within a browser session.
@@ -5326,26 +5328,39 @@ export declare const ImageMask: typeof Image.Mask;
  */
 export declare type ImageSource = Image.Source;
 
-declare type InterExtensionLaunchOptions = IntraExtensionLaunchOptions & {
-    /** when launching command from a different extension, the owner or author (as defined in the extension's manifest) is necessary */
+/**
+ * Options for launching a command from another extension.
+ */
+declare type InterExtensionLaunchOptions = {
+    /** When launching command from a different extension, the owner or author (as defined in the extension's manifest) is necessary */
     ownerOrAuthorName: string;
-    /** when launching command from a different extension, the extension name (as defined in the extension's manifest) is necessary */
+    /** When launching command from a different extension, the extension name (as defined in the extension's manifest) is necessary */
     extensionName: string;
+    /** Command name as defined in the extension's manifest */
+    name: string;
+    /** {@link LaunchType.UserInitiated} or {@link LaunchType.Background} */
+    type: LaunchType;
+    /** Optional object for the argument properties and values as defined in the extension's manifest, for example: `{ "argument1": "value1" }` */
+    arguments?: Arguments | null;
+    /** 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) */
+    context?: LaunchContext | null;
+    /** Optional string to send as fallback text to the command */
+    fallbackText?: string | null;
 };
 
 /**
  * Options for launching a command from the same extension.
  */
 declare type IntraExtensionLaunchOptions = {
-    /** command name as defined in the extension's manifest */
+    /** Command name as defined in the extension's manifest */
     name: string;
     /** {@link LaunchType.UserInitiated} or {@link LaunchType.Background} */
     type: LaunchType;
-    /** optional object for the argument properties and values as defined in the extension's manifest, for example: `{ "argument1": "value1" }` */
+    /** Optional object for the argument properties and values as defined in the extension's manifest, for example: `{ "argument1": "value1" }` */
     arguments?: Arguments | null;
-    /** 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) */
+    /** 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) */
     context?: LaunchContext | null;
-    /** optional string to send as fallback text to the command */
+    /** Optional string to send as fallback text to the command */
     fallbackText?: string | null;
 };
 
@@ -5806,11 +5821,7 @@ declare interface LabelProps {
  * 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.
  *
- * @param options - A parameter object with the properties:
- * `name`: command name as defined in the extension's manifest
- * `type`: {@link LaunchType.UserInitiated} or {@link LaunchType.Background}
- * `arguments`: optional object for the argument properties and values as defined in the extension's manifest, for example: `{ "argument1": "value1" }`
- * `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)
+ * @param options - Options to launch a command within the same extension or in another extension.
  * @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.
@@ -5833,6 +5844,9 @@ declare interface LabelProps {
      [item: string]: any;
  }
 
+ /**
+  * Options for launching a command from the same extension or from another extension.
+  */
  declare type LaunchOptions = IntraExtensionLaunchOptions | InterExtensionLaunchOptions;
 
  /**