@raycast/api 1.26.1 → 1.27.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@raycast/api",
-  "version": "1.26.1",
+  "version": "1.27.1",
   "description": "Build extensions for Raycast with React and Node.js.",
   "author": "Raycast Technologies Ltd.",
   "homepage": "https://developers.raycast.com",
@@ -13,4 +13,4 @@
   "bin": {
     "ray": "./bin/ray"
   }
-}
+}

package/types/index.d.ts

@@ -172,6 +172,26 @@ export function getApplications(path?: PathLike): Promise<Application[]>;
  * @category Utilities
  */
 export function getDefaultApplication(path: PathLike): Promise<Application>;
+/**
+ * Opens a target with the default application or specified application.
+ *
+ * @param target The file, folder or URL to open.
+ * @param application The application name to use for opening the file. If no application is specified, the default application as determined by the system
+ * is used to open the specified file. Note that you can use the application name, app identifier, or absolute path to the app.
+ * @returns A promise that resolves when the target has been opened.
+ *
+ * @example
+ * ```typescript
+ * 
+ *
+ * export default async () => {
+ *   await open("https://www.raycast.com", "com.google.Chrome");
+ * };
+ * ```
+ *
+ * @category Utilities
+ */
+export function open(target: string, application?: Application | string): Promise<void>;
 /**
  * Copies text to the clipboard.
  *
@@ -225,30 +245,6 @@ export function clearClipboard(): Promise<void>;
  * @category Clipboard
  */
 export function pasteText(text: string): Promise<void>;
-/**
- * Gets the selected text of the frontmost application.
- *
- * @throws An error when no text is selected in the frontmost application.
- * @returns Returns a promise that resolves with the selected text.
- *
- * @example
- * ```typescript
- * 
- *
- * export default async () => {
- *   try {
- *     const selectedText = await getSelectedText();
- *     const transformedText = selectedText.toUpperCase();
- *     await pasteText(transformedText);
- *   } catch (error) {
- *     await showToast(ToastStyle.Failure, "Cannot transform text", String(error));
- *   }
- * };
- * ```
- *
- * @category Clipboard
- */
-export function getSelectedText(): Promise<string>;
 /**
  * A keyboard shortcut is defined by one or more modifier keys (command, control, etc.) and a single key equivalent (a character or special key).
  * See {@link KeyModifier} and {@link KeyEquivalent} for supported values.
@@ -861,10 +857,12 @@ global {
         interface IntrinsicElements {
             "ray-form": FormProps;
             "ray-form-textfield": FormTextFieldProps;
+            "ray-form-passwordfield": FormPasswordFieldProps;
             "ray-form-textarea": FormTextAreaProps;
             "ray-form-checkbox": FormCheckboxProps;
             "ray-form-datepicker": FormDatePickerProps;
             "ray-form-separator": FormSeparatorProps;
+            "ray-form-description": FormDescriptionProps;
             "ray-form-dropdown": FormDropdownProps;
             "ray-form-tagpicker": FormTagPickerProps;
             "ray-form-tagpicker-item": FormTagPickerItemProps;
@@ -931,12 +929,12 @@ export interface FormValues {
  */
 export interface FormProps extends ActionsInterface, NavigationChildInterface {
     /**
-     * The {@link FormItemElement} elements of the form.
+     * The Form.Item elements of the form.
      */
     children?: ReactElement<FormItemProps<FormValue>> | Array<ReactElement<FormItemProps<FormValue>>> | null;
 }
 /**
- * Shows a list of form items such as {@link FormViewTextField}, {@link FormViewCheckbox} or {@link FormViewDropdown}.
+ * Shows a list of form items such as {@link Form.TextField}, {@link Form.Checkbox} or {@link Form.Dropdown}.
  *
  * @category User Interface
  * @subcategory Form
@@ -951,9 +949,11 @@ export namespace Form {
     var displayName: string;
     var TextField: typeof FormTextField;
     var TextArea: typeof FormTextArea;
+    var PasswordField: typeof FormPasswordField;
     var Checkbox: typeof FormCheckbox;
     var DatePicker: typeof FormDatePicker;
     var Separator: typeof FormSeparator;
+    var Description: typeof FormDescription;
     var Dropdown: typeof FormDropdown;
     var DropdownSection: typeof FormDropdownSection;
     var DropdownItem: typeof FormDropdownItem;
@@ -961,7 +961,7 @@ export namespace Form {
     var TagPickerItem: typeof FormTagPickerItem;
 }
 /**
- * Props of the {@link Form.Item} React component.
+ * Props of the Form.Item React component.
  *
  * @category User Interface
  * @subcategory Form
@@ -1019,7 +1019,13 @@ export interface FormTextFieldProps extends FormItemProps<string> {
  *
  * export default function Command() {
  *   return (
- *     <Form onSubmit={(values) => console.log(values)}>
+ *     <Form
+ *       actions={
+ *         <ActionPanel>
+ *           <SubmitFormAction title="Submit Name" onSubmit={(values) => console.log(values)} />
+ *         </ActionPanel>
+ *       }
+ *     >
  *       <Form.TextField id="name" defaultValue="Steve" />
  *     </Form>
  *   );
@@ -1034,11 +1040,17 @@ export interface FormTextFieldProps extends FormItemProps<string> {
  * 
  *
  * export default function Command() {
- *   const [text, setText] = useState<string>();
+ *   const [name, setName] = useState<string>();
  *
  *   return (
- *     <Form onSubmit={(values) => console.log(values)}>
- *       <Form.TextField id="textfield" value={text} onChange={setText} />
+ *     <Form
+ *       actions={
+ *         <ActionPanel>
+ *           <SubmitFormAction title="Submit Name" onSubmit={(values) => console.log(values)} />
+ *         </ActionPanel>
+ *       }
+ *     >
+ *       <Form.TextField id="name" value={name} onChange={setName} />
  *     </Form>
  *   );
  * }
@@ -1060,6 +1072,82 @@ export namespace FormTextField {
     };
     var displayName: string;
 }
+/**
+ * Props of the {@link Form.PasswordField} React component.
+ *
+ * @category User Interface
+ * @subcategory Form
+ */
+export interface FormPasswordFieldProps extends FormItemProps<string> {
+    /**
+     * Placeholder text shown in the password field.
+     */
+    placeholder?: string;
+}
+/**
+ * A form item with a secure text field for password-entry in which the entered characters must be kept secret.
+ *
+ * @example
+ * Uncontrolled password field
+ *
+ * ```typescript
+ * 
+ *
+ * export default function Command() {
+ *   return (
+ *     <Form
+ *       actions={
+ *         <ActionPanel>
+ *           <SubmitFormAction title="Submit Password" onSubmit={(values) => console.log(values)} />
+ *         </ActionPanel>
+ *       }
+ *     >
+ *       <Form.PasswordField id="password" title="Enter Password" />
+ *     </Form>
+ *   );
+ * }
+ * ```
+ *
+ * @example
+ * Controlled password field
+ *
+ * ```typescript
+ * 
+ * 
+ *
+ * export default function Command() {
+ *   const [password, setPassword] = useState<string>();
+ *
+ *   return (
+ *     <Form
+ *       actions={
+ *         <ActionPanel>
+ *           <SubmitFormAction title="Submit Password" onSubmit={(values) => console.log(values)} />
+ *         </ActionPanel>
+ *       }
+ *     >
+ *       <Form.PasswordField id="password" value={password} onChange={setPassword} />
+ *     </Form>
+ *   );
+ * }
+ * ```
+ *
+ * @category User Interface
+ * @subcategory Form
+ */
+export function FormPasswordField(props: FormPasswordFieldProps): ReactElement<FormPasswordFieldProps>;
+export namespace FormPasswordField {
+    var propTypes: {
+        id: PropTypes.Validator<string>;
+        title: PropTypes.Requireable<string>;
+        storeValue: PropTypes.Requireable<boolean>;
+        value: PropTypes.Requireable<string>;
+        defaultValue: PropTypes.Requireable<string>;
+        placeholder: PropTypes.Requireable<string>;
+        onChange: PropTypes.Requireable<(...args: any[]) => any>;
+    };
+    var displayName: string;
+}
 /**
  * Props of the {@link Form.TextArea} React component.
  *
@@ -1083,11 +1171,17 @@ export interface FormTextAreaProps extends FormItemProps<string> {
  * 
  *
  * const DESCRIPTION =
- *   "We spend too much time starring at loading indicators. The Raycast team is dedicated to make everybody interact faster with their computers.";
+ *   "We spend too much time staring at loading indicators. The Raycast team is dedicated to make everybody interact faster with their computers.";
  *
  * export default function Command() {
  *   return (
- *     <Form onSubmit={(values) => console.log(values)}>
+ *     <Form
+ *       actions={
+ *         <ActionPanel>
+ *           <SubmitFormAction title="Submit Description" onSubmit={(values) => console.log(values)} />
+ *         </ActionPanel>
+ *       }
+ *     >
  *       <Form.TextArea id="description" defaultValue={DESCRIPTION} />
  *     </Form>
  *   );
@@ -1102,11 +1196,17 @@ export interface FormTextAreaProps extends FormItemProps<string> {
  * 
  *
  * export default function Command() {
- *   const [text, setText] = useState<string>();
+ *   const [description, setDescription] = useState<string>();
  *
  *   return (
- *     <Form onSubmit={(values) => console.log(values)}>
- *       <Form.TextArea id="textarea" value={text} onChange={setText} />
+ *     <Form
+ *       actions={
+ *         <ActionPanel>
+ *           <SubmitFormAction title="Submit Description" onSubmit={(values) => console.log(values)} />
+ *         </ActionPanel>
+ *       }
+ *     >
+ *       <Form.TextArea id="description" value={description} onChange={setDescription} />
  *     </Form>
  *   );
  * }
@@ -1151,8 +1251,14 @@ export interface FormCheckboxProps extends FormItemProps<boolean> {
  *
  * export default function Command() {
  *   return (
- *     <Form onSubmit={(values) => console.log(values)}>
- *       <Form.Checkbox id="checkbox" label="Are you happy?" defaultValue={true} />
+ *     <Form
+ *       actions={
+ *         <ActionPanel>
+ *           <SubmitFormAction title="Submit Answer" onSubmit={(values) => console.log(values)} />
+ *         </ActionPanel>
+ *       }
+ *     >
+ *       <Form.Checkbox id="answer" label="Are you happy?" defaultValue={true} />
  *     </Form>
  *   );
  * }
@@ -1169,8 +1275,14 @@ export interface FormCheckboxProps extends FormItemProps<boolean> {
  *   const [checked, setChecked] = useState(true);
  *
  *   return (
- *     <Form onSubmit={(values) => console.log(values)}>
- *       <Form.Checkbox id="checkbox" label="Do you like orange juice?" value={checked} onChange={setChecked} />
+ *     <Form
+ *       actions={
+ *         <ActionPanel>
+ *           <SubmitFormAction title="Submit Answer" onSubmit={(values) => console.log(values)} />
+ *         </ActionPanel>
+ *       }
+ *     >
+ *       <Form.Checkbox id="answer" label="Do you like orange juice?" value={checked} onChange={setChecked} />
  *     </Form>
  *   );
  * }
@@ -1211,7 +1323,13 @@ export interface FormDatePickerProps extends FormItemProps<Date> {
  *
  * export default function Command() {
  *   return (
- *     <Form onSubmit={(values) => console.log(values)}>
+ *     <Form
+ *       actions={
+ *         <ActionPanel>
+ *           <SubmitFormAction title="Submit Form" onSubmit={(values) => console.log(values)} />
+ *         </ActionPanel>
+ *       }
+ *     >
  *       <Form.DatePicker id="dateOfBirth" title="Date of Birth" defaultValue={new Date(1955, 1, 24)} />
  *     </Form>
  *   );
@@ -1229,7 +1347,13 @@ export interface FormDatePickerProps extends FormItemProps<Date> {
  *   const [date, setDate] = useState<Date>();
  *
  *   return (
- *     <Form onSubmit={(values) => console.log(values)}>
+ *     <Form
+ *       actions={
+ *         <ActionPanel>
+ *           <SubmitFormAction title="Submit Form" onSubmit={(values) => console.log(values)} />
+ *         </ActionPanel>
+ *       }
+ *     >
  *       <Form.DatePicker id="launchDate" title="Launch Date" value={date} onChange={setDate} />
  *     </Form>
  *   );
@@ -1269,7 +1393,13 @@ export interface FormSeparatorProps {
  *
  * export default function Command() {
  *   return (
- *     <Form onSubmit={(values) => console.log(values)}>
+ *     <Form
+ *       actions={
+ *         <ActionPanel>
+ *           <SubmitFormAction title="Submit Form" onSubmit={(values) => console.log(values)} />
+ *         </ActionPanel>
+ *       }
+ *     >
  *       <Form.TextField id="textfield" />
  *       <Form.Separator />
  *       <Form.TextArea id="textarea" />
@@ -1297,6 +1427,58 @@ export interface FormDropdownProps extends FormItemProps<string> {
      */
     children?: ReactElement<FormDropdownSectionProps> | Array<ReactElement<FormDropdownSectionProps>> | ReactElement<FormDropdownItemProps> | Array<ReactElement<FormDropdownItemProps>> | null;
 }
+/**
+ * Props of the {@link Form.Label} React component.
+ *
+ * @category User Interface
+ * @subcategory Form
+ */
+export interface FormDescriptionProps {
+    /**
+     * The display title of the left side from the description item.
+     */
+    title?: string;
+    /**
+     * Text that will be displayed in the middle.
+     */
+    text: string;
+}
+/**
+ * A form item with a simple text label.
+ *
+ * @remark Do *not* use this component to show validation messages for other form fields.
+ *
+ * @example
+ * Label
+ *
+ * ```typescript
+ * 
+ *
+ * export default function Command() {
+ *   return (
+ *     <Form
+ *       actions={
+ *         <ActionPanel>
+ *           <SubmitFormAction title="Submit" onSubmit={(values) => console.log(values)} />
+ *         </ActionPanel>
+ *       }
+ *     >
+ *       <Form.Description title="Import / Export" text="Exporting will back-up your preferences, quicklinks, snippets, floating notes, script-command folder paths, aliases, hotkeys, favorites and other data." />
+ *     </Form>
+ *   );
+ * }
+ * ```
+ *
+ * @category User Interface
+ * @subcategory Form
+ */
+export function FormDescription(props: FormDescriptionProps): ReactElement<FormDescriptionProps>;
+export namespace FormDescription {
+    var propTypes: {
+        text: PropTypes.Requireable<string>;
+    };
+    var displayName: string;
+}
 /**
  * A form item with a dropdown menu.
  *
@@ -1308,7 +1490,13 @@ export interface FormDropdownProps extends FormItemProps<string> {
  *
  * export default function Command() {
  *   return (
- *     <Form onSubmit={(values) => console.log(values)}>
+ *     <Form
+ *       actions={
+ *         <ActionPanel>
+ *           <SubmitFormAction title="Submit Favorite" onSubmit={(values) => console.log(values)} />
+ *         </ActionPanel>
+ *       }
+ *     >
  *       <Form.Dropdown id="emoji" title="Favorite Emoji" defaultValue="lol">
  *         <Form.Dropdown.Item value="poop" title="Pile of poop" icon="💩" />
  *         <Form.Dropdown.Item value="rocket" title="Rocket" icon="🚀" />
@@ -1330,7 +1518,13 @@ export interface FormDropdownProps extends FormItemProps<string> {
  *   const [programmingLanguage, setProgrammingLanguage] = useState<string>("typescript");
  *
  *   return (
- *     <Form onSubmit={(values) => console.log(values)}>
+ *     <Form
+ *       actions={
+ *         <ActionPanel>
+ *           <SubmitFormAction title="Submit Favorite" onSubmit={(values) => console.log(values)} />
+ *         </ActionPanel>
+ *       }
+ *     >
  *       <Form.Dropdown
  *         id="dropdown"
  *         title="Favorite Language"
@@ -1395,7 +1589,13 @@ export interface FormDropdownSectionProps {
  *
  * export default function Command() {
  *   return (
- *     <Form onSubmit={(values) => console.log(values)}>
+ *     <Form
+ *       actions={
+ *         <ActionPanel>
+ *           <SubmitFormAction title="Submit Favorite" onSubmit={(values) => console.log(values)} />
+ *         </ActionPanel>
+ *       }
+ *     >
  *       <Form.Dropdown id="food" title="Favorite Food">
  *         <Form.Dropdown.Section title="Fruits">
  *           <Form.Dropdown.Item value="apple" title="Apple" icon="🍎" />
@@ -1452,7 +1652,13 @@ export interface FormDropdownItemProps {
  *
  * export default function Command() {
  *   return (
- *     <Form onSubmit={(values) => console.log(values)}>
+ *     <Form
+ *       actions={
+ *         <ActionPanel>
+ *           <SubmitFormAction title="Submit Icon" onSubmit={(values) => console.log(values)} />
+ *         </ActionPanel>
+ *       }
+ *     >
  *       <Form.Dropdown id="icon" title="Icon">
  *         <Form.Dropdown.Item value="circle" title="Cirlce" icon={Icon.Circle} />
  *       </Form.Dropdown>
@@ -1513,7 +1719,13 @@ export interface FormTagPickerProps extends FormItemProps<string[]> {
  *
  * export default function Command() {
  *   return (
- *     <Form onSubmit={(values) => console.log(values)}>
+ *     <Form
+ *       actions={
+ *         <ActionPanel>
+ *           <SubmitFormAction title="Submit Favorite" onSubmit={(values) => console.log(values)} />
+ *         </ActionPanel>
+ *       }
+ *     >
  *       <Form.TagPicker id="sports" title="Favorite Sports" defaultValue={["football"]}>
  *         <Form.TagPicker.Item value="basketball" title="Basketball" icon="🏀" />
  *         <Form.TagPicker.Item value="football" title="Football" icon="⚽️" />
@@ -1535,7 +1747,13 @@ export interface FormTagPickerProps extends FormItemProps<string[]> {
  *   const [countries, setCountries] = useState<string[]>(["ger", "ned", "pol"]);
  *
  *   return (
- *     <Form onSubmit={(values) => console.log(values)}>
+ *     <Form
+ *       actions={
+ *         <ActionPanel>
+ *           <SubmitFormAction title="Submit Countries" onSubmit={(values) => console.log(values)} />
+ *         </ActionPanel>
+ *       }
+ *     >
  *       <Form.TagPicker id="countries" title="Visited Countries" value={countries} onChange={setCountries}>
  *         <Form.TagPicker.Item value="ger" title="Germany" icon="🇩🇪" />
  *         <Form.TagPicker.Item value="ind" title="India" icon="🇮🇳" />
@@ -1597,9 +1815,17 @@ export interface FormTagPickerItemProps {
  *
  * export default function Command() {
  *   return (
- *     <Form onSubmit={(values) => console.log(values)}>
+ *     <Form
+ *       actions={
+ *         <ActionPanel>
+ *           <SubmitFormAction title="Submit Color" onSubmit={(values) => console.log(values)} />
+ *         </ActionPanel>
+ *       }
+ *     >
  *       <Form.TagPicker id="color" title="Color">
- *         <Form.TagPicker.Item value="ger" title="Germany" icon={{ source: Icon.Circle, tintColor: Color.Red }} />
+ *         <Form.TagPicker.Item value="red" title="Red" icon={{ source: Icon.Circle, tintColor: Color.Red }} />
+ *         <Form.TagPicker.Item value="green" title="Green" icon={{ source: Icon.Circle, tintColor: Color.Green }} />
+ *         <Form.TagPicker.Item value="blue" title="Blue" icon={{ source: Icon.Circle, tintColor: Color.Blue }} />
  *       </Form.TagPicker>
  *     </Form>
  *   );
@@ -2665,7 +2891,7 @@ export interface Preference {
     /**
      * The type of the preference.
      */
-    type: "textfield" | "password" | "checkbox" | "dropdown";
+    type: "appPicker" | "checkbox" | "dropdown" | "password" | "textfield";
     /**
      * Specifies if the preference is required.
      *
@@ -2698,6 +2924,7 @@ export interface Preference {
     /**
      * The default value of the preference if there is no `value` specified.
      * For dropdowns, this references the `value` property of an object in the data array.
+     * For app pickers, this references an application name, bundleId or path."
      */
     default?: unknown;
     /**
@@ -2756,6 +2983,66 @@ export interface PreferenceValues {
  * @category Preferences
  */
 export function getPreferenceValues<Values extends PreferenceValues = PreferenceValues>(): Values;
+/**
+ * Gets the selected text of the frontmost application.
+ *
+ * @throws An error when no text is selected in the frontmost application.
+ * @returns Returns a promise that resolves with the selected text.
+ *
+ * @example
+ * ```typescript
+ * 
+ *
+ * export default async () => {
+ *   try {
+ *     const selectedText = await getSelectedText();
+ *     const transformedText = selectedText.toUpperCase();
+ *     await pasteText(transformedText);
+ *   } catch (error) {
+ *     await showToast(ToastStyle.Failure, "Cannot transform text", String(error));
+ *   }
+ * };
+ * ```
+ *
+ * @category Environment
+ */
+export function getSelectedText(): Promise<string>;
+/**
+ * Holds data about a File System item. Use the {@link getSelectedFinderItems} method to retrieve values.
+ *
+ * @category Environment
+ */
+export interface FileSystemItem {
+    /**
+     * The path to the item
+     */
+    path: string;
+}
+/**
+ * Gets the selected items from Finder.
+ *
+ * @throws An error when Finder is not the frontmost application.
+ * @returns Returns a promise that resolves with the selected file system items.
+ *
+ * @example
+ * ```typescript
+ * 
+ *
+ * export default async () => {
+ *   try {
+ *     const selectedItems = await getSelectedFinderItems();
+ *     if (selectedItems.length) {
+ *       await pasteText(selectedItems[0].path);
+ *     }
+ *   } catch (error) {
+ *     await showToast(ToastStyle.Failure, "Cannot copy file path", String(error));
+ *   }
+ * };
+ * ```
+ *
+ * @category Environment
+ */
+export function getSelectedFinderItems(): Promise<FileSystemItem[]>;
 
 
 /**
@@ -2897,6 +3184,150 @@ export function useNavigation(): Navigation;
  * @subcategory Rendering
  */
 export function render(nodeToRender: ReactNode): void;
+
+/**
+ * Creates and shows a confirmation Alert with the given options.
+ *
+ * @param options - The options used to create the Alert.
+ * @returns A promise that resolves to a boolean when the user takes an action.
+ * It will be `true` for the primary Action, `false` for the dismiss Action.
+ *
+ * @example
+ * ```typescript
+ * 
+ *
+ * export default async () => {
+ *   if (await confirmAlert({ title: "Are you sure?" })) {
+ *     // do something
+ *   }
+ * };
+ * ```
+ *
+ * @category User Interface
+ * @subcategory Alert
+ */
+export function confirmAlert(options: AlertOptions): Promise<boolean>;
+/**
+ * The options to create an {@link Alert}.
+ *
+ * @example
+ * ```typescript
+ * 
+ *
+ * export default async () => {
+ *   const options: AlertOptions = {
+ *     title: "Finished cooking",
+ *     message: "Delicious pasta for lunch",
+ *     primaryAction: {
+ *       title: 'Do something',
+ *       onAction: () => {
+ *         // while you can register a handler for an action, it's more elegant
+ *         // to use the `if (await confirmAlert(...)) { ... }` pattern
+ *         console.log("The alert action has been triggered")
+ *       }
+ *     }
+ *   };
+ *   await confirmAlert(options);
+ * };
+ * ```
+ *
+ * @category User Interface
+ * @subcategory Alert
+ */
+export interface AlertOptions {
+    /**
+     * The icon of an alert to illustrate the action. Displayed on the top.
+     */
+    icon?: ImageLike;
+    /**
+     * The title of an alert. Displayed below the icon.
+     */
+    title: string;
+    /**
+     * An additional message for an Alert. Useful to show more information, e.g. a confirmation message for a destructive action.
+     */
+    message?: string;
+    /**
+     * The primary Action the user can take.
+     */
+    primaryAction?: AlertActionOptions;
+    /**
+     * The Action to dismiss the alert. There usually shouldn't be any side effects when the user takes this action.
+     */
+    dismissAction?: AlertActionOptions;
+}
+/**
+ * The options to create an {@link Alert} Action.
+ *
+ * @category User Interface
+ * @subcategory Alert
+ */
+export interface AlertActionOptions {
+    /**
+     * The title of the action.
+     */
+    title: string;
+    /**
+     * The style of the action.
+     */
+    style?: AlertActionStyle;
+    /**
+     * A callback called when the action is triggered.
+     */
+    onAction?: () => void;
+}
+/**
+ * Defines the visual style of an Action of the Alert.
+ *
+ * @remarks
+ * Use {@link AlertActionStyle.Default} for confirmations of a positive action.
+ * Use {@link AlertActionStyle.Destructive} for confirmations of a destructive action (eg. deleting a file).
+ *
+ * @category User Interface
+ * @subcategory Alert
+ */
+export enum AlertActionStyle {
+    Default = "DEFAULT",
+    Cancel = "CANCEL",
+    Destructive = "DESTRUCTIVE"
+}
+/**
+ * Union type for the supported color types.
+ *
+ * @remark
+ * Besides the {@link Color}, you can use any of the following color formats:
+ * - HEX, e.g `#FF0000`
+ * - Short HEX, e.g. `#F00`
+ * - RGBA, e.g. `rgb(255, 0, 0)`
+ * - RGBA Percentage, e.g. `rgb(255, 0, 0, 1.0)`
+ * - HSL, e.g. `hsla(200, 20%, 33%, 0.2)`
+ * - Keywords, e.g. `red`
+ *
+ * Colors different to the built-in ones (see {@link Color}) will be dynamically adjusted to fit the contrast.
+ *
+ * @example
+ * ```typescript
+ * 
+ *
+ * export default function Command() {
+ *   return (
+ *     <List>
+ *       <List.Item title="Built-in color" icon={{ source: Icon.Circle, tintColor: Color.Red }} />
+ *       <List.Item title="HEX" icon={{ source: Icon.Circle, tintColor: "#FF0000" }} />
+ *       <List.Item title="Short HEX" icon={{ source: Icon.Circle, tintColor: "#F00" }} />
+ *       <List.Item title="RGBA" icon={{ source: Icon.Circle, tintColor: "rgb(255, 0, 0)" }} />
+ *       <List.Item title="RGBA Percentage" icon={{ source: Icon.Circle, tintColor: "rgb(255, 0, 0, 1.0)" }} />
+ *       <List.Item title="HSL" icon={{ source: Icon.Circle, tintColor: "hsla(200, 20%, 33%, 0.2)" }} />
+ *       <List.Item title="Keywords" icon={{ source: Icon.Circle, tintColor: "red" }} />
+ *     </List>
+ *   );
+ * };
+ * ```
+ *
+ * @category User Interface
+ * @subcategory Colors
+ */
+export type ColorLike = Color | DynamicColor | string;
 /**
  * The standard colors. Use this colors for consistency.
  *
@@ -2960,7 +3391,7 @@ export enum Color {
  * @category User Interface
  * @subcategory Colors
  */
-interface DynamicColor {
+export interface DynamicColor {
     /**
      * The color which is used in light theme.
      *
@@ -2988,44 +3419,6 @@ interface DynamicColor {
      */
     adjustContrast?: boolean;
 }
-/**
- * Union type for the supported color types.
- *
- * @remark
- * Besides the {@link Color}, you can use any of the following color formats:
- * - HEX, e.g `#FF0000`
- * - Short HEX, e.g. `#F00`
- * - RGBA, e.g. `rgb(255, 0, 0)`
- * - RGBA Percentage, e.g. `rgb(255, 0, 0, 1.0)`
- * - HSL, e.g. `hsla(200, 20%, 33%, 0.2)`
- * - Keywords, e.g. `red`
- *
- * Colors different to the built-in ones (see {@link Color}) will be dynamically adjusted to fit the contrast.
- *
- * @example
- * ```typescript
- * 
- *
- * export default function Command() {
- *   return (
- *     <List>
- *       <List.Item title="Built-in color" icon={{ source: Icon.Circle, tintColor: Color.Red }} />
- *       <List.Item title="HEX" icon={{ source: Icon.Circle, tintColor: "#FF0000" }} />
- *       <List.Item title="Short HEX" icon={{ source: Icon.Circle, tintColor: "#F00" }} />
- *       <List.Item title="RGBA" icon={{ source: Icon.Circle, tintColor: "rgb(255, 0, 0)" }} />
- *       <List.Item title="RGBA Percentage" icon={{ source: Icon.Circle, tintColor: "rgb(255, 0, 0, 1.0)" }} />
- *       <List.Item title="HSL" icon={{ source: Icon.Circle, tintColor: "hsla(200, 20%, 33%, 0.2)" }} />
- *       <List.Item title="Keywords" icon={{ source: Icon.Circle, tintColor: "red" }} />
- *     </List>
- *   );
- * };
- * ```
- *
- * @category User Interface
- * @subcategory Colors
- */
-export type ColorLike = DynamicColor | Color | string;
-export {};
 /**
  * List of built-in icons that can be used for actions or list items.
  *
@@ -3116,7 +3509,7 @@ export enum Icon {
  */
 export interface FileIcon {
     /**
-     * The path to a file or folder to get it's icon from.
+     * The path to a file or folder to get its icon from.
      */
     fileIcon: string;
 }
@@ -3252,6 +3645,7 @@ export enum ImageMask {
      */
     RoundedRectangle = "roundedRectangle"
 }
+
 /**
  * A Toast with a certain style, title, and message.
  *
@@ -3279,17 +3673,23 @@ export enum ImageMask {
  */
 export class Toast {
     private options;
-    constructor(options: ToastOptions);
+    private id;
+    private callbacks;
+    constructor(props: ToastOptions);
     get style(): ToastStyle;
     set style(style: ToastStyle);
     get title(): string;
     set title(title: string);
     get message(): string | undefined;
     set message(message: string | undefined);
+    get primaryAction(): ToastActionOptions | undefined;
+    set primaryAction(action: ToastActionOptions | undefined);
+    get secondaryAction(): ToastActionOptions | undefined;
+    set secondaryAction(action: ToastActionOptions | undefined);
     /**
      * Shows the Toast.
      *
-     * @returns A promise that resolves when toast is shown.
+     * @returns A promise that resolves when the toast is shown.
      */
     show(): Promise<void>;
     /**
@@ -3312,6 +3712,12 @@ export class Toast {
  *     style: ToastStyle.Success,
  *     title: "Finished cooking",
  *     message: "Delicious pasta for lunch",
+ *     primaryAction: {
+ *       title: 'Do something',
+ *       onAction: () => {
+ *         console.log("The toast action has been triggered")
+ *       }
+ *     }
  *   };
  *   const toast = new Toast(options);
  *   await toast.show();
@@ -3331,9 +3737,37 @@ export interface ToastOptions {
      */
     title: string;
     /**
-     * An additional message for the toast. Useful to show more information, e.g. an identifier of a newly create asset
+     * An additional message for the toast. Useful to show more information, e.g. an identifier of a newly created asset.
      */
     message?: string;
+    /**
+     * The primary Action the user can take when hovering on the Toast.
+     */
+    primaryAction?: ToastActionOptions;
+    /**
+     * The secondary Action the user can take when hovering on the Toast.
+     */
+    secondaryAction?: ToastActionOptions;
+}
+/**
+ * The options to create a {@link Toast} Action.
+ *
+ * @category User Interface
+ * @subcategory Toast
+ */
+export interface ToastActionOptions {
+    /**
+     * The title of the action.
+     */
+    title: string;
+    /**
+     * The keyboard shortcut for the action.
+     */
+    shortcut?: KeyboardShortcut;
+    /**
+     * A callback called when the action is triggered.
+     */
+    onAction: () => void;
 }
 /**
  * Defines the visual style of the Toast.
@@ -3352,7 +3786,7 @@ export enum ToastStyle {
     Animated = "ANIMATED"
 }
 /**
- * Creates and shows a Toast with the the given style, title, and message.
+ * Creates and shows a Toast with the given style, title, and message.
  *
  * @param style - The visual style of the Toast.
  * @param title - The title that will be displayed in the Toast.