@raycast/api 1.77.3 → 1.78.1

package/package.json

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

@@ -2381,6 +2381,10 @@ export declare interface Environment {
      * The version of the main Raycast app
      */
     raycastVersion: string;
+    /**
+     * The name of the extension owner (if any) or author, as specified in package.json
+     */
+    ownerOrAuthorName: string;
     /**
      * The name of the extension, as specified in package.json
      */
@@ -2462,7 +2466,6 @@ export declare interface Environment {
  * console.log(`Is development mode: ${environment.isDevelopment}`);
  * console.log(`Raycast appearance: ${environment.appearance}`);
  * console.log(`Raycast launchType: ${environment.launchType}`);
- * console.log(`Raycast launchContext: ${environment.launchContext}`);
  * ```
  */
 export declare const environment: Environment;
@@ -5372,7 +5375,7 @@ declare type InterExtensionLaunchOptions = {
     type: LaunchType;
     /** Optional object for the argument properties and values as defined in the extension's manifest, for example: `{ "argument1": "value1" }` */
     arguments?: Arguments | null;
-    /** Arbitrary object for custom data that should be passed to the command and accessible as `environment.launchContext`; the object must be JSON serializable (Dates and Buffers supported) */
+    /** Arbitrary object for custom data that should be passed to the command and accessible as {@link LaunchProps}; the object must be JSON serializable (Dates and Buffers supported) */
     context?: LaunchContext | null;
     /** Optional string to send as fallback text to the command */
     fallbackText?: string | null;
@@ -5388,7 +5391,7 @@ declare type IntraExtensionLaunchOptions = {
     type: LaunchType;
     /** Optional object for the argument properties and values as defined in the extension's manifest, for example: `{ "argument1": "value1" }` */
     arguments?: Arguments | null;
-    /** Arbitrary object for custom data that should be passed to the command and accessible as `environment.launchContext`; the object must be JSON serializable (Dates and Buffers supported) */
+    /** Arbitrary object for custom data that should be passed to the command and accessible as {@link LaunchProps}; the object must be JSON serializable (Dates and Buffers supported) */
     context?: LaunchContext | null;
     /** Optional string to send as fallback text to the command */
     fallbackText?: string | null;
@@ -7217,7 +7220,7 @@ declare interface LabelProps {
           * Called when the user scrolls to the bottom of the view and there are more items to load.
           * When this is called, the command should update the list of items to include the next page.
           */
-         onLoadMore: (page: number) => void;
+         onLoadMore: () => void;
      };
  }
 
@@ -8554,4 +8557,126 @@ declare interface LabelProps {
  /** @deprecated Use `useAI` from `@raycast/utils` */
  export declare const useUnstableAI: () => any;
 
+ export declare namespace WindowManagement {
+     /**
+      * The type of a {@link Desktop}.
+      */
+     export enum DesktopType {
+         /** The default Desktop type. It can contain any number of {@link Window} */
+         User = "User",
+         /** A Desktop made of a single fullscreen window */
+         FullScreen = "FullScreen"
+     }
+     /**
+      * A Window from an {@link Application} on a {@link Desktop}.
+      */
+     export type Window = {
+         id: string;
+         application?: Application;
+         bounds: {
+             position: {
+                 x: number;
+                 y: number;
+             };
+             size: {
+                 width: number;
+                 height: number;
+             };
+         } | "fullscreen";
+         desktopId: string;
+         fullScreenSettable: boolean;
+         resizable: boolean;
+         positionable: boolean;
+         active: boolean;
+     };
+     /**
+      * A Desktop represents a virtual desktop on a Screen.
+      */
+     export type Desktop = {
+         size: {
+             width: number;
+             height: number;
+         };
+         id: string;
+         screenId: string;
+         active: boolean;
+         type: DesktopType;
+     };
+     /**
+      * Gets the list of {@link Desktop}s available across all screens.
+      *
+      * @returns A Promise that resolves with the desktops.
+      *
+      * @example
+      * ```typescript
+      * import { getDesktops, showToast } from "@raycast/api";
+      *
+      * export default async function Command() {
+      *   const desktops = await getDesktops();
+      *   const screens = Set(desktops.map((desktop) => desktop.screenId));
+      *   showToast({title: `Found ${desktops.length} desktops on ${screens.size} screens.`});
+      * }
+      * ```
+      */
+     export function getDesktops(): Promise<Desktop[]>;
+
+     /**
+      * Gets the list of {@link Window}s on the active {@link Desktop}.
+      *
+      * @returns A Promise that resolves with an array of Windows.
+      *
+      * @example
+      * ```typescript
+      * import { getWindowsOnActiveDesktop, setWindowBounds, showToast } from "@raycast/api";
+      *
+      * export default async function Command() {
+      *   const windows = await getWindowsOnActiveDesktop();
+      *   const chrome = windows.find((x) => x.application?.bundleId === "com.google.Chrome");
+      *   if (!chrome) {
+      *     showToast({ title: "Couldn't find chrome", style: Toast.Style.Failure });
+      *     return;
+      *   }
+      *   setWindowBounds({ id: chrome.id, bounds: { position: { x: 100 } } })
+      * }
+      * ```
+      */
+     export function getWindowsOnActiveDesktop(): Promise<Window[]>;
+     /**
+      * Move a {@link Window} or make it fullscreen.
+      *
+      * @returns A Promise that resolves with the window was moved. If the move isn't possible (for example trying to make a window fullscreen that doesn't support it), the promise will be rejected.
+      *
+      * @example
+      * ```typescript
+      * import { getActiveWindow, setWindowBounds, showToast } from "@raycast/api";
+      *
+      * export default async function Command() {
+      *   try {
+      *     const window = await getActiveWindow();
+      *     setWindowBounds({ id: window.id, bounds: { position: { x: 100 } } })
+      *   } catch (error) {
+      *     showToast({ title: "Could not move window", message: error.message, style: Toast.Style.Failure });
+      *   }
+      * }
+      * ```
+      */
+     export function setWindowBounds(options: {
+         id: string;
+     } & ({
+         bounds: {
+             position?: {
+                 x?: number;
+                 y?: number;
+             };
+             size?: {
+                 width?: number;
+                 height?: number;
+             };
+         };
+         desktopId?: string;
+     } | {
+         bounds: "fullscreen";
+     })): Promise<void>;
+ }
+
  export { }