@raycast/api 1.48.7 → 1.48.8

package/api.d.ts

@@ -3,6 +3,7 @@
 
 import { ForwardRefExoticComponent } from 'react';
 import { FunctionComponent } from 'react';
+import { MutableRefObject } from 'react';
 import { PathLike } from 'fs';
 import { ReactElement } from 'react';
 import { ReactNode } from 'react';
@@ -3851,6 +3852,8 @@ declare interface FormValues_2 {
     [item: string]: any;
 }
 
+declare type FunctionReturningPromise<T extends any[] = any[]> = (...args: T) => Promise<any>;
+
 /**
  * Returns all applications that can open the file.
  *
@@ -6921,6 +6924,14 @@ export declare interface PreferenceValues {
     [name: string]: any;
 }
 
+declare type PromiseOptions<T extends FunctionReturningPromise> = {
+    abortable?: MutableRefObject<AbortController | null | undefined>;
+    execute?: boolean;
+    onError?: (error: Error) => void | Promise<void>;
+    onData?: (data: Awaited<ReturnType<T>>) => void | Promise<void>;
+    onWillExecute?: (parameters: Parameters<T>) => void;
+};
+
 /**
  * See {@link Action.Push.Props}
  */
@@ -7889,24 +7900,24 @@ export declare namespace unstable_AI {
      * import { usePromise } from "@raycast/utils";
      * import { useState } from "react";
      *
-     * export default function Command(props: LaunchProps<{ arguments: { instruction: string } }>) {
+     * export default function Command(props: LaunchProps<{ arguments: { prompt: string } }>) {
      *   const [data, setData] = useState("");
      *   const { isLoading } = usePromise(
-     *     async (instruction) => {
-     *       const stream = unstable_AI.ask(instruction);
+     *     async (prompt) => {
+     *       const stream = unstable_AI.ask(prompt);
      *       stream.on("data", (data) => {
      *         setData((x) => x + data);
      *       });
      *       await stream;
      *     },
-     *     [props.arguments.instruction]
+     *     [props.arguments.prompt]
      *   );
      *
      *   return <Detail isLoading={isLoading} markdown={data} />;
      * }
      * ```
      */
-    export function ask(instruction: string, options?: AnswerOptions): Promise<string> & {
+    export function ask(prompt: string, options?: AnswerOptions): Promise<string> & {
         on(event: "data", listener: (chunk: string) => void): void;
     };
     export type AnswerOptions = {
@@ -7921,14 +7932,9 @@ export declare namespace unstable_AI {
     };
     /**
      * Concrete tasks, such as fixing grammar, require less creativity while open-ended questions, such as generating ideas, require more.
+     * If a number is passed, it needs to be in the range 0-2. For larger values, 2 will be used. For lower values, 0 will be used.
      */
-    export enum Creativity {
-        None = 0,
-        Low = 0.25,
-        Medium = 0.5,
-        High = 0.75,
-        Maximum = 1
-    }
+    export type Creativity = "none" | "low" | "medium" | "high" | "maximum" | number;
 }
 
 /**
@@ -8015,27 +8021,28 @@ 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.
+ * The AI API is not stable and should move to the "@raycast/utils" package 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.
+ * Stream a prompt 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);
+ * export default function Command(props: LaunchProps<{ arguments: { prompt: string } }>) {
+ *   const { isLoading, data } = useUnstableAI(props.arguments.prompt);
  *
  *   return <Detail isLoading={isLoading} markdown={data} />;
  * }
  * ```
  */
-export declare function useUnstableAI(instruction: string, options?: {
+export declare function useUnstableAI(prompt: string, options?: {
     creativity?: unstable_AI.Creativity;
-}): {
+    stream?: boolean;
+} & Omit<PromiseOptions<FunctionReturningPromise>, "abortable">): {
     isLoading: boolean;
     data: string;
     error: Error;

package/package.json

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

package/types/index.d.ts

@@ -3,6 +3,7 @@
 
 import { ForwardRefExoticComponent } from 'react';
 import { FunctionComponent } from 'react';
+import { MutableRefObject } from 'react';
 import { PathLike } from 'fs';
 import { ReactElement } from 'react';
 import { ReactNode } from 'react';
@@ -3847,6 +3848,8 @@ declare interface FormValues_2 {
     [item: string]: any;
 }
 
+declare type FunctionReturningPromise<T extends any[] = any[]> = (...args: T) => Promise<any>;
+
 /**
  * Returns all applications that can open the file.
  *
@@ -6917,6 +6920,14 @@ export declare interface PreferenceValues {
     [name: string]: any;
 }
 
+declare type PromiseOptions<T extends FunctionReturningPromise> = {
+    abortable?: MutableRefObject<AbortController | null | undefined>;
+    execute?: boolean;
+    onError?: (error: Error) => void | Promise<void>;
+    onData?: (data: Awaited<ReturnType<T>>) => void | Promise<void>;
+    onWillExecute?: (parameters: Parameters<T>) => void;
+};
+
 /**
  * See {@link Action.Push.Props}
  */
@@ -7885,24 +7896,24 @@ export declare namespace unstable_AI {
      * import { usePromise } from "@raycast/utils";
      * import { useState } from "react";
      *
-     * export default function Command(props: LaunchProps<{ arguments: { instruction: string } }>) {
+     * export default function Command(props: LaunchProps<{ arguments: { prompt: string } }>) {
      *   const [data, setData] = useState("");
      *   const { isLoading } = usePromise(
-     *     async (instruction) => {
-     *       const stream = unstable_AI.ask(instruction);
+     *     async (prompt) => {
+     *       const stream = unstable_AI.ask(prompt);
      *       stream.on("data", (data) => {
      *         setData((x) => x + data);
      *       });
      *       await stream;
      *     },
-     *     [props.arguments.instruction]
+     *     [props.arguments.prompt]
      *   );
      *
      *   return <Detail isLoading={isLoading} markdown={data} />;
      * }
      * ```
      */
-    export function ask(instruction: string, options?: AnswerOptions): Promise<string> & {
+    export function ask(prompt: string, options?: AnswerOptions): Promise<string> & {
         on(event: "data", listener: (chunk: string) => void): void;
     };
     export type AnswerOptions = {
@@ -7917,14 +7928,9 @@ export declare namespace unstable_AI {
     };
     /**
      * Concrete tasks, such as fixing grammar, require less creativity while open-ended questions, such as generating ideas, require more.
+     * If a number is passed, it needs to be in the range 0-2. For larger values, 2 will be used. For lower values, 0 will be used.
      */
-    export enum Creativity {
-        None = 0,
-        Low = 0.25,
-        Medium = 0.5,
-        High = 0.75,
-        Maximum = 1
-    }
+    export type Creativity = "none" | "low" | "medium" | "high" | "maximum" | number;
 }
 
 /**
@@ -8011,27 +8017,28 @@ 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.
+ * The AI API is not stable and should move to the "@raycast/utils" package 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.
+ * Stream a prompt 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);
+ * export default function Command(props: LaunchProps<{ arguments: { prompt: string } }>) {
+ *   const { isLoading, data } = useUnstableAI(props.arguments.prompt);
  *
  *   return <Detail isLoading={isLoading} markdown={data} />;
  * }
  * ```
  */
-export declare function useUnstableAI(instruction: string, options?: {
+export declare function useUnstableAI(prompt: string, options?: {
     creativity?: unstable_AI.Creativity;
-}): {
+    stream?: boolean;
+} & Omit<PromiseOptions<FunctionReturningPromise>, "abortable">): {
     isLoading: boolean;
     data: string;
     error: Error;