@raycast/api 1.71.4 → 1.72.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@raycast/api",
-  "version": "1.71.4",
+  "version": "1.72.0",
   "description": "Build extensions for Raycast with React and Node.js.",
   "author": "Raycast Technologies Ltd.",
   "homepage": "https://developers.raycast.com",

package/types/index.d.ts

@@ -649,6 +649,89 @@ export declare interface ArgumentsLaunchProps {
     arguments?: Arguments;
 }
 
+export declare namespace BrowserExtension {
+
+    /**
+     * Get the content of the active tab.
+     *
+     * @returns A Promise that resolves with the content.
+     *
+     * @example
+     * ```typescript
+     * import { BrowserExtension } from "@raycast/api";
+     *
+     * export default async () => {
+     *   const html = await BrowserExtension.getContent({ format: "html" });
+     *   console.log(html);
+     * };
+     * ```
+     */
+    export function getContent(options?: GetContentOptions): Promise<string>;
+    export type GetContentOptions = {
+        /**
+         * The format of the content.
+         *
+         * - `html`: `document.documentElement.outerHTML`
+         * - `text`: `document.body.innerText`
+         * - `markdown`: A heuristic to get the "content" of the document and convert it to markdown. Think of it as the "reader mode" of a browser.
+         *
+         * @defaultValue `html`
+         */
+        format?: "html" | "text" | "markdown";
+        /**
+         * Only returns the content of the element that matches the [CSS selector](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_selectors).
+         *
+         * If the selector matches multiple elements, only the first one is returned.
+         * If the selector doesn't match any element, an empty string is returned.
+         *
+         * When using a CSS selector, the `format` option can not be `markdown`.
+         */
+        cssSelector?: string;
+        /**
+         * The ID of the tab to get the content from. If not specified, the content of the active tab of the focused window is returned.
+         */
+        tabId?: number;
+    };
+    export interface Tab {
+        /**
+         * The ID of the tab. Tab IDs are unique within a browser session.
+         */
+        id: number;
+        /**
+         * The URL the tab is displaying.
+         */
+        url: string;
+        /**
+         * The title of the tab. It may also be `undefined` if the tab is loading.
+         */
+        title?: string;
+        /**
+         * The URL of the tab's [favicon](https://developer.mozilla.org/en-US/docs/Glossary/Favicon). It may also be `undefined` if the tab is loading.
+         */
+        favicon?: string;
+        /**
+         * Whether the tab is active in its window.
+         * There can only be one active tab per window but if there are multiple browser windows, there can be multiple active tabs.
+         */
+        active: boolean;
+    }
+    /**
+     * Get the list of browser tabs.
+     * @returns A Promise that resolves with the list of tabs.
+     *
+     * @example
+     * ```typescript
+     * import { BrowserExtension } from "@raycast/api";
+     *
+     * export default async () => {
+     *   const tabs = await BrowserExtension.getTabs();
+     *   console.log(tabs);
+     * };
+     * ```
+     */
+    export function getTabs(): Promise<Tab[]>;
+}
+
 /**
  * Caching abstraction that stores data on disk and supports LRU (least recently used) access.
  * Since extensions can only consume up to a max. heap memory size, the cache only maintains a lightweight index in memory