@raycast/api 1.27.0 → 1.27.1

package/package.json

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

@@ -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.
  *
@@ -837,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;
@@ -927,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;
@@ -1048,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.
  *
@@ -1071,7 +1171,7 @@ 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 (
@@ -1327,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.
  *
@@ -2739,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.
      *
@@ -2772,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;
     /**