@raycast/api 1.50.5 → 1.51.1

package/api.d.ts

@@ -3,7 +3,6 @@
 
 import { ForwardRefExoticComponent } from 'react';
 import { FunctionComponent } from 'react';
-import { MutableRefObject } from 'react';
 import { PathLike } from 'fs';
 import { ReactElement } from 'react';
 import { ReactNode } from 'react';
@@ -436,6 +435,63 @@ declare enum ActionStyle {
     Destructive = "destructive"
 }
 
+export declare namespace AI {
+    /**
+     * Returns a prompt completion.
+     *
+     * @example
+     * ```typescript
+     * import { Detail, AI, LaunchProps } from "@raycast/api";
+     * import { usePromise } from "@raycast/utils";
+     * import { useState } from "react";
+     *
+     * export default function Command(props: LaunchProps<{ arguments: { prompt: string } }>) {
+     *   const [data, setData] = useState("");
+     *   const { isLoading } = usePromise(
+     *     async (prompt) => {
+     *       const stream = AI.ask(prompt);
+     *       stream.on("data", (data) => {
+     *         setData((x) => x + data);
+     *       });
+     *       await stream;
+     *     },
+     *     [props.arguments.prompt]
+     *   );
+     *
+     *   return <Detail isLoading={isLoading} markdown={data} />;
+     * }
+     * ```
+     */
+    export function ask(prompt: string, options?: AskOptions): Promise<string> & {
+        on(event: "data", listener: (chunk: string) => void): void;
+    };
+    export type AskOptions = {
+        /**
+         * 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.
+         */
+        creativity?: Creativity;
+        /**
+         * The AI model to use to answer to the prompt.
+         */
+        model?: Model;
+        /**
+         * 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.
+     * 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 type Creativity = "none" | "low" | "medium" | "high" | "maximum" | number;
+    /**
+     * The AI model to use to answer to the prompt.
+     * @defaultValue `"text-davinci-003"`
+     */
+    export type Model = "text-davinci-003" | "gpt-3.5-turbo";
+}
+
 export declare namespace Alert {
     /**
      * The options to create an {@link Alert}.
@@ -1014,10 +1070,9 @@ export declare namespace Color {
      * - Keywords, e.g. `red`
      */
     export type Raw = string;
-    /** The standard colors. Use those colors for consistency.
-     *
-     * @remarks
-     * The colors automatically adapt to the Raycast theme (light or dark).
+    /**
+     * @deprecated `Color.Brown` isn't part of the custom themes and might look off
+     * for some users. Use another color instead.
      */
     const Brown: Color.Dynamic;
 }
@@ -2157,8 +2212,13 @@ export declare interface Environment {
      * Indicates whether the command is a development command (vs. an installed command from the Store).
      */
     isDevelopment: boolean;
+    /**
+     * The appearance used by the Raycast application.
+     */
+    appearance: "light" | "dark";
     /**
      * The theme used by the Raycast application.
+     * @deprecated Use `appearance` instead
      */
     theme: "light" | "dark";
     /**
@@ -2204,7 +2264,7 @@ export declare interface Environment {
  * console.log(`Assets path: ${environment.assetsPath}`);
  * console.log(`Support path: ${environment.supportPath}`);
  * console.log(`Is development mode: ${environment.isDevelopment}`);
- * console.log(`Raycast theme: ${environment.theme}`);
+ * console.log(`Raycast appearance: ${environment.appearance}`);
  * console.log(`Raycast launchType: ${environment.launchType}`);
  * console.log(`Raycast launchContext: ${environment.launchContext}`);
  * ```
@@ -3867,8 +3927,6 @@ 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.
  *
@@ -6940,14 +6998,6 @@ 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}
  */
@@ -7902,65 +7952,8 @@ 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: { prompt: string } }>) {
-     *   const [data, setData] = useState("");
-     *   const { isLoading } = usePromise(
-     *     async (prompt) => {
-     *       const stream = unstable_AI.ask(prompt);
-     *       stream.on("data", (data) => {
-     *         setData((x) => x + data);
-     *       });
-     *       await stream;
-     *     },
-     *     [props.arguments.prompt]
-     *   );
-     *
-     *   return <Detail isLoading={isLoading} markdown={data} />;
-     * }
-     * ```
-     */
-    export function ask(prompt: string, options?: AskOptions): Promise<string> & {
-        on(event: "data", listener: (chunk: string) => void): void;
-    };
-    export type AskOptions = {
-        /**
-         * 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.
-         */
-        creativity?: Creativity;
-        /**
-         * The AI model to use to answer to the prompt.
-         */
-        model?: Model;
-        /**
-         * 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.
-     * 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 type Creativity = "none" | "low" | "medium" | "high" | "maximum" | number;
-    /**
-     * @default `"text-davinci-003"``
-     */
-    export type Model = "text-davinci-003" | "gpt-3.5-turbo";
-}
+/** @deprecated Use {@Link AI} directly */
+export declare const unstable_AI: typeof AI;
 
 /**
  * Update the values of properties declared in the manifest of a command.
@@ -8045,41 +8038,7 @@ export declare const useId: any;
  */
 export declare function useNavigation(): Navigation;
 
-/**
- * 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 a prompt completion.
- *
- * @example
- * ```typescript
- * import { Detail, useUnstableAI, LaunchProps } from "@raycast/api";
- *
- * 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(prompt: string, options?: {
-    /**
-     * 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.
-     */
-    creativity?: unstable_AI.Creativity;
-    /**
-     * The AI model to use to answer to the prompt.
-     */
-    model?: unstable_AI.Model;
-    stream?: boolean;
-} & Omit<PromiseOptions<FunctionReturningPromise>, "abortable">): {
-    isLoading: boolean;
-    data: string;
-    error: Error;
-    revalidate: () => Promise<void>;
-};
+/** @deprecated Use `useAI` from `@raycast/utils` */
+export declare const useUnstableAI: () => any;
 
 export { }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@raycast/api",
-  "version": "1.50.5",
+  "version": "1.51.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

@@ -3,7 +3,6 @@
 
 import { ForwardRefExoticComponent } from 'react';
 import { FunctionComponent } from 'react';
-import { MutableRefObject } from 'react';
 import { PathLike } from 'fs';
 import { ReactElement } from 'react';
 import { ReactNode } from 'react';
@@ -432,6 +431,63 @@ declare enum ActionStyle {
     Destructive = "destructive"
 }
 
+export declare namespace AI {
+    /**
+     * Returns a prompt completion.
+     *
+     * @example
+     * ```typescript
+     * import { Detail, AI, LaunchProps } from "@raycast/api";
+     * import { usePromise } from "@raycast/utils";
+     * import { useState } from "react";
+     *
+     * export default function Command(props: LaunchProps<{ arguments: { prompt: string } }>) {
+     *   const [data, setData] = useState("");
+     *   const { isLoading } = usePromise(
+     *     async (prompt) => {
+     *       const stream = AI.ask(prompt);
+     *       stream.on("data", (data) => {
+     *         setData((x) => x + data);
+     *       });
+     *       await stream;
+     *     },
+     *     [props.arguments.prompt]
+     *   );
+     *
+     *   return <Detail isLoading={isLoading} markdown={data} />;
+     * }
+     * ```
+     */
+    export function ask(prompt: string, options?: AskOptions): Promise<string> & {
+        on(event: "data", listener: (chunk: string) => void): void;
+    };
+    export type AskOptions = {
+        /**
+         * 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.
+         */
+        creativity?: Creativity;
+        /**
+         * The AI model to use to answer to the prompt.
+         */
+        model?: Model;
+        /**
+         * 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.
+     * 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 type Creativity = "none" | "low" | "medium" | "high" | "maximum" | number;
+    /**
+     * The AI model to use to answer to the prompt.
+     * @defaultValue `"text-davinci-003"`
+     */
+    export type Model = "text-davinci-003" | "gpt-3.5-turbo";
+}
+
 export declare namespace Alert {
     /**
      * The options to create an {@link Alert}.
@@ -1010,10 +1066,9 @@ export declare namespace Color {
      * - Keywords, e.g. `red`
      */
     export type Raw = string;
-    /** The standard colors. Use those colors for consistency.
-     *
-     * @remarks
-     * The colors automatically adapt to the Raycast theme (light or dark).
+    /**
+     * @deprecated `Color.Brown` isn't part of the custom themes and might look off
+     * for some users. Use another color instead.
      */
     const Brown: Color.Dynamic;
 }
@@ -2153,8 +2208,13 @@ export declare interface Environment {
      * Indicates whether the command is a development command (vs. an installed command from the Store).
      */
     isDevelopment: boolean;
+    /**
+     * The appearance used by the Raycast application.
+     */
+    appearance: "light" | "dark";
     /**
      * The theme used by the Raycast application.
+     * @deprecated Use `appearance` instead
      */
     theme: "light" | "dark";
     /**
@@ -2200,7 +2260,7 @@ export declare interface Environment {
  * console.log(`Assets path: ${environment.assetsPath}`);
  * console.log(`Support path: ${environment.supportPath}`);
  * console.log(`Is development mode: ${environment.isDevelopment}`);
- * console.log(`Raycast theme: ${environment.theme}`);
+ * console.log(`Raycast appearance: ${environment.appearance}`);
  * console.log(`Raycast launchType: ${environment.launchType}`);
  * console.log(`Raycast launchContext: ${environment.launchContext}`);
  * ```
@@ -3863,8 +3923,6 @@ 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.
  *
@@ -6936,14 +6994,6 @@ 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}
  */
@@ -7898,65 +7948,8 @@ 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: { prompt: string } }>) {
-     *   const [data, setData] = useState("");
-     *   const { isLoading } = usePromise(
-     *     async (prompt) => {
-     *       const stream = unstable_AI.ask(prompt);
-     *       stream.on("data", (data) => {
-     *         setData((x) => x + data);
-     *       });
-     *       await stream;
-     *     },
-     *     [props.arguments.prompt]
-     *   );
-     *
-     *   return <Detail isLoading={isLoading} markdown={data} />;
-     * }
-     * ```
-     */
-    export function ask(prompt: string, options?: AskOptions): Promise<string> & {
-        on(event: "data", listener: (chunk: string) => void): void;
-    };
-    export type AskOptions = {
-        /**
-         * 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.
-         */
-        creativity?: Creativity;
-        /**
-         * The AI model to use to answer to the prompt.
-         */
-        model?: Model;
-        /**
-         * 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.
-     * 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 type Creativity = "none" | "low" | "medium" | "high" | "maximum" | number;
-    /**
-     * @default `"text-davinci-003"``
-     */
-    export type Model = "text-davinci-003" | "gpt-3.5-turbo";
-}
+/** @deprecated Use {@Link AI} directly */
+export declare const unstable_AI: typeof AI;
 
 /**
  * Update the values of properties declared in the manifest of a command.
@@ -8041,41 +8034,7 @@ export declare const useId: any;
  */
 export declare function useNavigation(): Navigation;
 
-/**
- * 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 a prompt completion.
- *
- * @example
- * ```typescript
- * import { Detail, useUnstableAI, LaunchProps } from "@raycast/api";
- *
- * 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(prompt: string, options?: {
-    /**
-     * 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.
-     */
-    creativity?: unstable_AI.Creativity;
-    /**
-     * The AI model to use to answer to the prompt.
-     */
-    model?: unstable_AI.Model;
-    stream?: boolean;
-} & Omit<PromiseOptions<FunctionReturningPromise>, "abortable">): {
-    isLoading: boolean;
-    data: string;
-    error: Error;
-    revalidate: () => Promise<void>;
-};
+/** @deprecated Use `useAI` from `@raycast/utils` */
+export declare const useUnstableAI: () => any;
 
 export { }