@raycast/api 1.48.5 → 1.48.7

package/api.d.ts

@@ -4992,6 +4992,29 @@ 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 */
+    ownerOrAuthorName: string;
+    /** when launching command from a different extension, the extension name (as defined in the extension's manifest) is necessary */
+    extensionName: string;
+};
+
+/**
+ * Options for launching a command from the same extension.
+ */
+declare type IntraExtensionLaunchOptions = {
+    /** 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;
+};
+
 /**
  * See {@link List.Item}
  */
@@ -5361,12 +5384,7 @@ declare interface LabelProps {
  * };
  * ```
  */
-export declare function launchCommand(options: {
-    name: string;
-    type: LaunchType;
-    arguments?: Arguments | null;
-    context?: LaunchContext | null;
-}): Promise<void>;
+export declare function launchCommand(options: LaunchOptions): Promise<void>;
 
 declare interface LaunchContext {
     /**
@@ -5375,6 +5393,8 @@ declare interface LaunchContext {
     [item: string]: any;
 }
 
+declare type LaunchOptions = IntraExtensionLaunchOptions | InterExtensionLaunchOptions;
+
 /**
  * The top-level props that a Command receives on launch
  */
@@ -7856,22 +7876,59 @@ declare interface TrashProps {
 }
 
 /**
- * @beta
+ * The AI API is not stable, it will likely change in the future based the community's feedback.
+ * If you have any feedback, concerns, or use-cases that aren't covered by the API, please reach out to us on the [Raycast Community Slack](https://raycast.com/community).
  */
 export declare namespace unstable_AI {
     /**
+     * Returns a prompt completion.
      *
+     * @example
+     * ```typescript
+     * import { Detail, unstable_AI, LaunchProps } from "@raycast/api";
+     * import { usePromise } from "@raycast/utils";
+     * import { useState } from "react";
+     *
+     * export default function Command(props: LaunchProps<{ arguments: { instruction: string } }>) {
+     *   const [data, setData] = useState("");
+     *   const { isLoading } = usePromise(
+     *     async (instruction) => {
+     *       const stream = unstable_AI.ask(instruction);
+     *       stream.on("data", (data) => {
+     *         setData((x) => x + data);
+     *       });
+     *       await stream;
+     *     },
+     *     [props.arguments.instruction]
+     *   );
+     *
+     *   return <Detail isLoading={isLoading} markdown={data} />;
+     * }
+     * ```
      */
-    export function answer(prompt: string, options?: AnswerOptions): Promise<string> & {
+    export function ask(instruction: string, options?: AnswerOptions): Promise<string> & {
         on(event: "data", listener: (chunk: string) => void): void;
     };
     export type AnswerOptions = {
         /**
          * Between 0 and 1
          */
-        temperature?: number;
-        maxTokens?: number;
+        creativity?: Creativity;
+        /**
+         * Abort signal to cancel the request.
+         */
+        signal?: AbortSignal;
     };
+    /**
+     * Concrete tasks, such as fixing grammar, require less creativity while open-ended questions, such as generating ideas, require more.
+     */
+    export enum Creativity {
+        None = 0,
+        Low = 0.25,
+        Medium = 0.5,
+        High = 0.75,
+        Maximum = 1
+    }
 }
 
 /**
@@ -7957,4 +8014,32 @@ export declare const useId: any;
  */
 export declare function useNavigation(): Navigation;
 
+/**
+ * The AI API is not stable and should move to @raycast/utils eventually, it will likely change in the future based the community's feedback.
+ * If you have any feedback, concerns, or use-cases that aren't covered by the API, please reach out to us on the [Raycast Community Slack](https://raycast.com/community).
+ *
+ * ---
+ *
+ * Stream an instruction completion.
+ *
+ * @example
+ * ```typescript
+ * import { Detail, useUnstableAI, LaunchProps } from "@raycast/api";
+ *
+ * export default function Command(props: LaunchProps<{ arguments: { instruction: string } }>) {
+ *   const { isLoading, data } = useUnstableAI(props.arguments.instruction);
+ *
+ *   return <Detail isLoading={isLoading} markdown={data} />;
+ * }
+ * ```
+ */
+export declare function useUnstableAI(instruction: string, options?: {
+    creativity?: unstable_AI.Creativity;
+}): {
+    isLoading: boolean;
+    data: string;
+    error: Error;
+    revalidate: () => Promise<void>;
+};
+
 export { }

package/package.json

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

package/types/index.d.ts

@@ -4988,6 +4988,29 @@ 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 */
+    ownerOrAuthorName: string;
+    /** when launching command from a different extension, the extension name (as defined in the extension's manifest) is necessary */
+    extensionName: string;
+};
+
+/**
+ * Options for launching a command from the same extension.
+ */
+declare type IntraExtensionLaunchOptions = {
+    /** 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;
+};
+
 /**
  * See {@link List.Item}
  */
@@ -5357,12 +5380,7 @@ declare interface LabelProps {
  * };
  * ```
  */
-export declare function launchCommand(options: {
-    name: string;
-    type: LaunchType;
-    arguments?: Arguments | null;
-    context?: LaunchContext | null;
-}): Promise<void>;
+export declare function launchCommand(options: LaunchOptions): Promise<void>;
 
 declare interface LaunchContext {
     /**
@@ -5371,6 +5389,8 @@ declare interface LaunchContext {
     [item: string]: any;
 }
 
+declare type LaunchOptions = IntraExtensionLaunchOptions | InterExtensionLaunchOptions;
+
 /**
  * The top-level props that a Command receives on launch
  */
@@ -7851,6 +7871,62 @@ declare interface TrashProps {
     onTrash?: (paths: PathLike | PathLike[]) => void;
 }
 
+/**
+ * The AI API is not stable, it will likely change in the future based the community's feedback.
+ * If you have any feedback, concerns, or use-cases that aren't covered by the API, please reach out to us on the [Raycast Community Slack](https://raycast.com/community).
+ */
+export declare namespace unstable_AI {
+    /**
+     * Returns a prompt completion.
+     *
+     * @example
+     * ```typescript
+     * import { Detail, unstable_AI, LaunchProps } from "@raycast/api";
+     * import { usePromise } from "@raycast/utils";
+     * import { useState } from "react";
+     *
+     * export default function Command(props: LaunchProps<{ arguments: { instruction: string } }>) {
+     *   const [data, setData] = useState("");
+     *   const { isLoading } = usePromise(
+     *     async (instruction) => {
+     *       const stream = unstable_AI.ask(instruction);
+     *       stream.on("data", (data) => {
+     *         setData((x) => x + data);
+     *       });
+     *       await stream;
+     *     },
+     *     [props.arguments.instruction]
+     *   );
+     *
+     *   return <Detail isLoading={isLoading} markdown={data} />;
+     * }
+     * ```
+     */
+    export function ask(instruction: string, options?: AnswerOptions): Promise<string> & {
+        on(event: "data", listener: (chunk: string) => void): void;
+    };
+    export type AnswerOptions = {
+        /**
+         * Between 0 and 1
+         */
+        creativity?: Creativity;
+        /**
+         * Abort signal to cancel the request.
+         */
+        signal?: AbortSignal;
+    };
+    /**
+     * Concrete tasks, such as fixing grammar, require less creativity while open-ended questions, such as generating ideas, require more.
+     */
+    export enum Creativity {
+        None = 0,
+        Low = 0.25,
+        Medium = 0.5,
+        High = 0.75,
+        Maximum = 1
+    }
+}
+
 /**
  * Update the values of properties declared in the manifest of a command.
  *
@@ -7934,4 +8010,32 @@ export declare const useId: any;
  */
 export declare function useNavigation(): Navigation;
 
+/**
+ * The AI API is not stable and should move to @raycast/utils eventually, it will likely change in the future based the community's feedback.
+ * If you have any feedback, concerns, or use-cases that aren't covered by the API, please reach out to us on the [Raycast Community Slack](https://raycast.com/community).
+ *
+ * ---
+ *
+ * Stream an instruction completion.
+ *
+ * @example
+ * ```typescript
+ * import { Detail, useUnstableAI, LaunchProps } from "@raycast/api";
+ *
+ * export default function Command(props: LaunchProps<{ arguments: { instruction: string } }>) {
+ *   const { isLoading, data } = useUnstableAI(props.arguments.instruction);
+ *
+ *   return <Detail isLoading={isLoading} markdown={data} />;
+ * }
+ * ```
+ */
+export declare function useUnstableAI(instruction: string, options?: {
+    creativity?: unstable_AI.Creativity;
+}): {
+    isLoading: boolean;
+    data: string;
+    error: Error;
+    revalidate: () => Promise<void>;
+};
+
 export { }