@raycast/api 1.27.1 → 1.28.0

package/types/api/ui/image.d.ts

@@ -0,0 +1,161 @@
+import { Color } from "./color";
+import { FileIcon, Icon } from "./icon";
+/**
+ * Display different types of images, including network images or bundled assets.
+ *
+ * @example
+ * ```typescript
+ * // Built-in icon
+ * const icon = Icon.Eye
+ *
+ * // Built-in icon with tint color
+ * const tintedIcon = { source: Icon.Bubble, tintColor: Color.Red }
+ *
+ * // Bundled asset with circular mask
+ * const avatar = { source: "avatar.png", mask: Image.Mask.Circle }
+ *
+ * // Theme-aware icon
+ * const icon = { source: { light: "icon-light.png", dark: "icon-dark.png" }}
+ * ```
+ *
+ * @remark
+ * Apply image transforms to the source, such as a `mask` or a `tintColor`.
+ */
+export interface Image {
+    /**
+     * The {@link Image.Source} of the image.
+     */
+    source: Image.Source;
+    /**
+     * {@link Image.Fallback} image, in case `source` can't be loaded.
+     */
+    fallback?: Image.Fallback;
+    /**
+     * A {@link Image.Mask} to apply to the image.
+     */
+    mask?: Image.Mask;
+    /**
+     * A {@link Color.ColorLike} to tint all the non-transparent pixels of the image.
+     */
+    tintColor?: Color.ColorLike;
+}
+export declare namespace Image {
+    /**
+     * Image is a string representing a URL.
+     */
+    type URL = string;
+    /**
+     * Image is a string denoting an asset from the `assets/` folder.
+     */
+    type Asset = string;
+    /**
+     * Union type for the supported image types.
+     *
+     * @example
+     * ```typescript
+     * import { Icon, Image, List } from "@raycast/api";
+     *
+     * export default function Command() {
+     *   return (
+     *     <List>
+     *       <List.Item title="String" icon="https://raycast.com/uploads/avatar.png" />
+     *       <List.Item title="Icon" icon={Icon.Circle} />
+     *       <List.Item title="FileIcon" icon={{ fileIcon: __filename }} />
+     *       <List.Item title="Image" icon={{ source: "https://raycast.com/uploads/avatar.png", mask: Image.Mask.Circle }} />
+     *     </List>
+     *   );
+     * };
+     * ```
+     */
+    type ImageLike = URL | Asset | Icon | FileIcon | Image;
+    /**
+     * The source of an {@link Image}. Can be either a remote URL, a local file resource, a built-in {@link Icon} or
+     * a single emoji.
+     *
+     * @remarks
+     * For consistency, it's best to use the built-in {@link Icon} in lists, the Action Panel, and other places. If a
+     * specific icon isn't built-in, you can reference custom ones from the `assets` folder of the extension by file name,
+     * e.g. `my-icon.png`. Alternatively, you can reference an absolute HTTPS URL that points to an image or use an emoji.
+     * You can also specify different remote or local assets for light and dark theme.
+     *
+     * @example
+     * ```typescript
+     * import { Icon, List } from "@raycast/api";
+     *
+     * export default function Command() {
+     *   return (
+     *     <List>
+     *       <List.Item title="String" icon={{ source: "https://raycast.com/uploads/avatar.png" }} />
+     *       <List.Item title="Icon" icon={{ source: Icon.Circle }} />
+     *       <List.Item
+     *         title="Theme"
+     *         icon={{
+     *           source: { light: "https://raycast.com/uploads/avatar.png", dark: "https://raycast.com/uploads/avatar.png" },
+     *         }}
+     *       />
+     *     </List>
+     *   );
+     * };
+     * ```
+     */
+    type Source = URL | Asset | Icon | {
+        light: URL | Asset;
+        dark: URL | Asset;
+    };
+    /**
+     * Fallback {@link Image} source. Can be a local file resource, a built-in {@link Icon} or a single emoji.
+     *
+     * @example
+     * ```typescript
+     * import { Icon, List } from "@raycast/api";
+     *
+     * export default function Command() {
+     *   return (
+     *     <List>
+     *       <List.Item title="String" icon={{ source: "https://raycast.com/uploads/avatar.png", fallback: Icon.Circle }} />
+     *       <List.Item title="Icon" icon={{ source: Icon.Circle }} />
+     *       <List.Item
+     *         title="Theme"
+     *         icon={{
+     *           source: { light: "https://raycast.com/uploads/avatar.png", dark: "https://raycast.com/uploads/avatar.png" },
+     *         }}
+     *       />
+     *     </List>
+     *   );
+     * };
+     * ```
+     */
+    type Fallback = Asset | Icon | {
+        light: Asset;
+        dark: Asset;
+    };
+    /**
+     * Available masks that can be used to change the shape of an image.
+     *
+     * @remarks
+     * Can be handy to shape avatars or other items in a list.
+     *
+     * @example
+     * ```typescript
+     * import { Image, List } from "@raycast/api";
+     *
+     * export default function Command() {
+     *   return (
+     *     <List>
+     *       <List.Item title="Icon" icon={{ source: "https://raycast.com/uploads/avatar.png", mask: Image.Mask.Circle }} />
+     *     </List>
+     *   );
+     * };
+     * ```
+     */
+    enum Mask {
+        /**
+         * Masks an image with a circle. Good to use for avatars.
+         */
+        Circle = "circle",
+        /**
+         * Masks an image with a rounded rectangle.
+         */
+        RoundedRectangle = "roundedRectangle"
+    }
+}

package/types/api/ui/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./color";
+export * from "./errors";
+export * from "./icon";
+export * from "./image";
+export * from "./feedback";

package/types/core/message-types.d.ts

@@ -0,0 +1,17 @@
+export declare type WorkerMessage = RequestMessage | NotifyMessage | ResultMessage;
+export declare type RequestMessage = {
+    kind: "request";
+    id: string;
+    method: string;
+    params: MessageParams;
+};
+export declare type NotifyMessage = {
+    kind: "notify";
+    method: string;
+    params: MessageParams;
+};
+export declare type ResultMessage = {
+    kind: "result";
+    id: string;
+    result: MessageResult;
+};

package/types/core/preferences.d.ts

@@ -0,0 +1,69 @@
+/**
+ * A record type holding the preferences (entered in Raycast Preferences) that have been passed to the command.
+ */
+export declare type Preferences = Record<string, Preference>;
+/**
+ * Holds data about a single preference item (entered in Raycast Preferences).
+ *
+ * @remarks
+ * The object maps to a defined preference in the `package.json` manifest file.
+ */
+export interface Preference {
+    /**
+     * The name of the preference.
+     */
+    name: string;
+    /**
+     * The type of the preference.
+     */
+    type: "appPicker" | "checkbox" | "dropdown" | "password" | "textfield";
+    /**
+     * Specifies if the preference is required.
+     *
+     * @remarks
+     * If the preference is required, an onboarding view is shown when the
+     * extension is opened for the first time.
+     *
+     * @defaultValue false
+     */
+    required: boolean;
+    /**
+     * The title of the preference.
+     *
+     * @remarks
+     * The title is also shown in the Raycast preferences.
+     */
+    title: string;
+    /**
+     * The description of the preference.
+     *
+     * @remarks
+     * The description is shown in the Raycast preferences as well as in the
+     * onboarding view for required preferences.
+     */
+    description: string;
+    /**
+     * The value of the preference.
+     */
+    value?: unknown;
+    /**
+     * 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;
+    /**
+     * A placeholder that is used for text fields and passwords.
+     */
+    placeholder?: string;
+    /**
+     * A label that is used for checkboxes.
+     * You can create checkbox groups by setting this property and leaving the title property empty for all checkboxes except the first.
+     */
+    label?: string;
+    /**
+     * The data that is used for dropdowns.
+     * For the dropdown items, add an array of objects with `title` and `value` properties, such as: `{"title": "Foo", "value": "bar"}`
+     */
+    data?: unknown[];
+}