@raycast/api 1.29.1 → 1.30.2

package/README.md

@@ -1,6 +1,6 @@
 <p align="center">
   <img src="https://raw.githubusercontent.com/raycast/extensions/main/images/store-logo.png" height="128">
-  <h1 align="center">Raycast Extensions (Beta)</h1>
+  <h1 align="center">Raycast Extensions</h1>
 </p>
 
 <p align="center">

package/package.json

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

package/types/api/app/clipboard.d.ts

@@ -45,3 +45,19 @@ export declare function clear(): Promise<void>;
  * ```
  */
 export declare function paste(text: string): Promise<void>;
+/**
+ * Reads the clipboard as plain text.
+ *
+ * @returns A promise that resolves when the clipboard content was read as plain text.
+ *
+ * @example
+ * ```typescript
+ * import { Clipboard } from "@raycast/api";
+ *
+ * export default async () => {
+ *   const text = await Clipboard.readText();
+ *   console.log(text);
+ * };
+ * ```
+ */
+export declare function readText(): Promise<string | undefined>;

package/types/api/components/ActionPanel.d.ts

@@ -71,42 +71,6 @@ declare namespace ActionPanelSubmenu {
                 light: PropTypes.Validator<string>;
                 dark: PropTypes.Validator<string>;
             }>>;
-            /**
-             * Exposes a list of actions that can be performed by the user.
-             *
-             * @remarks
-             * Often items are context-aware, e.g. based on the selected list item. Actions can be grouped into semantic
-             * sections and can have keyboard shortcuts assigned.
-             *
-             * The first and second action become the primary and secondary action. They automatically get the default keyboard shortcuts assigned.
-             * In {@link List} and {@link Detail}, this is `↵` for the primary and `⌘` `↵` for the secondary action. In {@link Form} it's `⌘` `↵` for the primary and
-             * `⌘` `⇧` `↵` for the secondary.
-             *
-             * @example
-             * ```typescript
-             * import { ActionPanel, Action, List } from "@raycast/api";
-             *
-             * export default function Command() {
-             *   return (
-             *     <List navigationTitle="Open Pull Requests">
-             *       <List.Item
-             *         title="Docs: Update API Reference"
-             *         subtitle="#1"
-             *         actions={
-             *           <ActionPanel title="#1 in raycast/extensions">
-             *             <Action.OpenInBrowser url="https://github.com/raycast/extensions/pull/1" />
-             *             <Action.CopyToClipboard
-             *               title="Copy Pull Request URL"
-             *               content="https://github.com/raycast/extensions/pull/1"
-             *             />
-             *           </ActionPanel>
-             *         }
-             *       />
-             *     </List>
-             *   );
-             * }
-             * ```
-             */
             fallback: PropTypes.Requireable<string | PropTypes.InferProps<{
                 light: PropTypes.Validator<string>;
                 dark: PropTypes.Validator<string>;

package/types/api/components/Detail.d.ts

@@ -1,4 +1,4 @@
-import { ReactElement, ReactNode } from "react";
+import { ReactElement } from "react";
 import { ActionsInterface, NavigationChildInterface } from "./types";
 import PropTypes from "prop-types";
 /**
@@ -34,7 +34,5 @@ export declare namespace Detail {
          * The CommonMark string to be rendered.
          */
         markdown?: string | null;
-        /** @deprecated - Use the `markdown` prop instead */
-        children?: ReactNode;
     }
 }

package/types/api/components/Form.d.ts

@@ -300,6 +300,24 @@ declare namespace FormTagPicker {
      */
     const Item: typeof FormTagPickerItem;
 }
+declare enum FormDatePickerType {
+    /**
+     * Only year, month, and day can be picked
+     */
+    Date = "date",
+    /**
+     * hour and second can be picked in addition to year, month and day
+     */
+    DateTime = "date_time"
+}
+declare namespace FormDatePicker {
+    /**
+     * The types of date components the user can pick
+     * * `Date` – only year, month, and day can be picked
+     * * `DateTime` – hour and second can be picked in addition to year, month and day
+     */
+    const Type: typeof FormDatePickerType;
+}
 export declare namespace Form {
     /**
      * @deprecated Use `Form.Dropdown.Section` instead.
@@ -849,7 +867,7 @@ export declare namespace Form {
          */
         interface Props extends Form.ItemProps<string> {
             /**
-             * Placeholder text shown in the text field.
+             * Placeholder text shown in the text area.
              */
             placeholder?: string;
         }
@@ -917,6 +935,12 @@ export declare namespace Form {
          * Props of the {@link Form.DatePicker} React component.
          */
         interface Props extends Form.ItemProps<Date> {
+            /**
+             * Indicates what types of date components can be picked
+             *
+             * @default Form.DatePicker.Type.DateTime
+             */
+            type?: FormDatePickerType;
         }
     }
     namespace Separator {

package/types/api/components/List.d.ts

@@ -1,9 +1,9 @@
 import { ReactElement, ReactNode } from "react";
+import PropTypes from "prop-types";
 import { Image } from "../ui";
 import { ActionsInterface, NavigationChildInterface } from "./types";
-import PropTypes from "prop-types";
 /**
- * Displays {@link List.Section} or {@link List.Item}.
+ * Displays {@link List.Section} or {@link List.Item}, optionally {@link List.Dropdown}.
  *
  * @remarks
  * The list uses built-in filtering by indexing the title of list items and additionally keywords.
@@ -12,9 +12,36 @@ import PropTypes from "prop-types";
  * ```typescript
  * import { List } from "@raycast/api";
  *
+ * function DrinkDropdown(props: DrinkDropdownProps) {
+ *   const { isLoading = false, drinkTypes, onDrinkTypeChange } = props;
+ *   return (
+ *     <List.Dropdown
+ *       tooltip="Select Drink Type"
+ *       storeValue={true}
+ *       onChange={(newValue) => {
+ *         onDrinkTypeChange(newValue);
+ *       }}
+ *     >
+ *       <List.Dropdown.Section title="Alcoholic Beverages">
+ *         {drinkTypes.map((drinkType) => (
+ *           <List.Dropdown.Item key={drinkType.id} title={drinkType.name} value={drinkType.id} />
+ *         ))}
+ *       </List.Dropdown.Section>
+ *     </List.Dropdown>
+ *   );
+ * }
+ *
  * export default function Command() {
+ *   const drinkTypes = [{ id: 1, name: 'Beer' }, { id: 2, name: 'Wine' }];
+ *   const onDrinkTypeChange = (newValue) => {
+ *     console.log(newValue);
+ *   }
  *   return (
- *     <List navigationTitle="Search Beers" searchBarPlaceholder="Search your favorite beer">
+ *     <List
+ *       navigationTitle="Search Beers"
+ *       searchBarPlaceholder="Search your favorite drink"
+ *       searchBarAccessory={<DrinkDropdown drinkTypes={drinkTypes} onDrinkTypeChange={onDrinkTypeChange} />}
+ *     >
  *       <List.Item title="Augustiner Helles" />
  *       <List.Item title="Camden Hells" />
  *       <List.Item title="Leffe Blonde" />
@@ -27,11 +54,16 @@ import PropTypes from "prop-types";
 export declare function List(props: List.Props): ReactElement<List.Props>;
 export declare namespace List {
     var propTypes: {
-        selectedItemId: PropTypes.Requireable<string>;
+        onSelectionChange: PropTypes.Requireable<(...args: any[]) => any>;
+        searchBarAccessory: PropTypes.Requireable<PropTypes.ReactNodeLike>;
+        searchText: PropTypes.Requireable<string>;
+        enableFiltering: PropTypes.Requireable<boolean>;
         searchBarPlaceholder: PropTypes.Requireable<string>;
+        selectedItemId: PropTypes.Requireable<string>;
         throttle: PropTypes.Requireable<boolean>;
         onSearchTextChange: PropTypes.Requireable<(...args: any[]) => any>;
-        onSelectionChange: PropTypes.Requireable<(...args: any[]) => any>;
+        isLoading: PropTypes.Requireable<boolean>;
+        navigationTitle: PropTypes.Requireable<string>;
     };
     var displayName: string;
 }
@@ -66,53 +98,74 @@ declare namespace ListItem {
                 dark: PropTypes.Validator<string>;
             }>>;
             fallback: PropTypes.Requireable<string | PropTypes.InferProps<{
-                /**
-                 * Displays {@link List.Section} or {@link List.Item}.
-                 *
-                 * @remarks
-                 * The list uses built-in filtering by indexing the title of list items and additionally keywords.
-                 *
-                 * @example
-                 * ```typescript
-                 * import { List } from "@raycast/api";
-                 *
-                 * export default function Command() {
-                 *   return (
-                 *     <List navigationTitle="Search Beers" searchBarPlaceholder="Search your favorite beer">
-                 *       <List.Item title="Augustiner Helles" />
-                 *       <List.Item title="Camden Hells" />
-                 *       <List.Item title="Leffe Blonde" />
-                 *       <List.Item title="Sierra Nevada IPA" />
-                 *     </List>
-                 *   );
-                 * }
-                 * ```
-                 */
                 light: PropTypes.Validator<string>;
                 dark: PropTypes.Validator<string>;
             }>>;
-            /**
-             * Displays {@link List.Section} or {@link List.Item}.
-             *
-             * @remarks
-             * The list uses built-in filtering by indexing the title of list items and additionally keywords.
-             *
-             * @example
-             * ```typescript
-             * import { List } from "@raycast/api";
-             *
-             * export default function Command() {
-             *   return (
-             *     <List navigationTitle="Search Beers" searchBarPlaceholder="Search your favorite beer">
-             *       <List.Item title="Augustiner Helles" />
-             *       <List.Item title="Camden Hells" />
-             *       <List.Item title="Leffe Blonde" />
-             *       <List.Item title="Sierra Nevada IPA" />
-             *     </List>
-             *   );
-             * }
-             * ```
-             */
+            mask: PropTypes.Requireable<Image.Mask>;
+            tintColor: PropTypes.Requireable<string | PropTypes.InferProps<{
+                light: PropTypes.Validator<string>;
+                dark: PropTypes.Validator<string>;
+                adjustContrast: PropTypes.Requireable<boolean>;
+            }>>;
+        }>>;
+    };
+    var displayName: string;
+}
+/**
+ * See {@link List.Item.Detail}
+ */
+declare function ListItemDetail(props: List.Item.Detail.Props): ReactElement<List.Item.Detail.Props>;
+declare namespace ListItemDetail {
+    var propTypes: {
+        isLoading: PropTypes.Requireable<boolean>;
+        markdown: PropTypes.Requireable<string>;
+    };
+    var displayName: string;
+}
+/**
+ * See {@link List.Dropdown}
+ */
+declare function ListDropdown(props: List.Dropdown.Props): ReactElement<List.Dropdown.Props>;
+declare namespace ListDropdown {
+    var propTypes: {
+        id: PropTypes.Requireable<string>;
+        tooltip: PropTypes.Validator<string>;
+        storeValue: (props: List.Dropdown.Props, propName: keyof List.Dropdown.Props, componentName: string, location: string, propFullName: string) => Error;
+        value: PropTypes.Requireable<string>;
+        defaultValue: PropTypes.Requireable<string>;
+        onChange: PropTypes.Requireable<(...args: any[]) => any>;
+    };
+    var displayName: string;
+}
+/**
+ * See {@link List.Dropdown.Section}
+ */
+declare function ListDropdownSection(props: List.Dropdown.Section.Props): ReactElement<List.Dropdown.Section.Props>;
+declare namespace ListDropdownSection {
+    var propTypes: {
+        title: PropTypes.Requireable<string>;
+    };
+    var displayName: string;
+}
+/**
+ * See {@link List.Dropdown.Item}
+ */
+declare function ListDropdownItem(props: List.Dropdown.Item.Props): ReactElement<List.Dropdown.Item.Props>;
+declare namespace ListDropdownItem {
+    var propTypes: {
+        value: PropTypes.Requireable<string>;
+        title: PropTypes.Validator<string>;
+        icon: PropTypes.Requireable<string | Required<PropTypes.InferProps<{
+            fileIcon: PropTypes.Validator<string>;
+        }>> | PropTypes.InferProps<{
+            source: PropTypes.Requireable<string | PropTypes.InferProps<{
+                light: PropTypes.Validator<string>;
+                dark: PropTypes.Validator<string>;
+            }>>;
+            fallback: PropTypes.Requireable<string | PropTypes.InferProps<{
+                light: PropTypes.Validator<string>;
+                dark: PropTypes.Validator<string>;
+            }>>;
             mask: PropTypes.Requireable<Image.Mask>;
             tintColor: PropTypes.Requireable<string | PropTypes.InferProps<{
                 light: PropTypes.Validator<string>;
@@ -172,6 +225,54 @@ export declare namespace List {
      * ```
      */
     const Section: typeof ListSection;
+    /**
+     * A dropdown menu that will be shown in the right-hand-side of the search bar.
+     *
+     * @example
+     * ```typescript
+     * import { List } from "@raycast/api";
+     *
+     * function DrinkDropdown(props: DrinkDropdownProps) {
+     *   const { isLoading = false, drinkTypes, onDrinkTypeChange } = props;
+     *   return (
+     *     <List.Dropdown
+     *       tooltip="Select Drink Type"
+     *       disabled={isLoading}
+     *       storeValue={true}
+     *       onChange={(newValue) => {
+     *         onDrinkTypeChange(newValue);
+     *       }}
+     *     >
+     *       <List.Dropdown.Section title="Alcoholic Beverages">
+     *         {drinkTypes.map((drinkType) => (
+     *           <List.Dropdown.Item key={drinkType.id} title={drinkType.name} value={drinkType.id} />
+     *         ))}
+     *       </List.Dropdown.Section>
+     *     </List.Dropdown>
+     *   );
+     * }
+     *
+     * export default function Command() {
+     *   const drinkTypes = [{ id: 1, name: 'Beer' }, { id: 2, name: 'Wine' }];
+     *   const onDrinkTypeChange = (newValue) => {
+     *     console.log(newValue);
+     *   }
+     *   return (
+     *     <List
+     *       navigationTitle="Search Beers"
+     *       searchBarPlaceholder="Search your favorite drink"
+     *       searchBarAccessory={<DrinkDropdown drinkTypes={drinkTypes} onDrinkTypeChange={onDrinkTypeChange} />}
+     *     >
+     *       <List.Item title="Augustiner Helles" />
+     *       <List.Item title="Camden Hells" />
+     *       <List.Item title="Leffe Blonde" />
+     *       <List.Item title="Sierra Nevada IPA" />
+     *     </List>
+     *   );
+     * }
+     * ```
+     */
+    const Dropdown: typeof ListDropdown;
     /**
      * Props of the {@link List} React component.
      */
@@ -184,6 +285,24 @@ export declare namespace List {
          * Callback triggered when the item selection in the list changes.
          */
         onSelectionChange?: (id?: string) => void;
+        /**
+         * {@link List.Dropdown} that will be shown in the right-hand-side of the search bar.
+         */
+        searchBarAccessory?: ReactElement<List.Dropdown.Props> | null | boolean;
+        /**
+         * The text that will be displayed in the search bar.
+         */
+        searchText?: string;
+        /**
+         * Toggles Raycast filtering. When `true`, Raycast will use the query in the search bar to filter list
+         * items. When `false`, the extension needs to take care of the filtering.
+         *
+         * @remarks
+         * Having this enabled when filtering items in the extension is unspecified behaviour.
+         *
+         * @defaultValue false when `onSearchTextChange` is specified, true otherwise.
+         */
+        enableFiltering?: boolean;
         /**
          * Placeholder text that will be shown in the search bar.
          *
@@ -202,9 +321,17 @@ export declare namespace List {
         throttle?: boolean;
         /**
          * Callback triggered when the search bar text changes.
-         * Note that built-in list filtering will be disabled when this callback is set.
+         *
+         * @remarks
+         * Specifying this implicitly toggles `enableFiltering` to false. To enable native filtering when using `onSearchTextChange`, explicitly set `enableFiltering` to true.
          */
         onSearchTextChange?: (text: string) => void;
+        /**
+         * Whether the List should have an area on the right side of the items to show additional details about the selected item.
+         *
+         * When true, it is recommended not to show any accessories on the `List.Item` and instead show the additional information in the `List.Item.Detail` view.
+         */
+        isShowingDetail?: boolean;
     }
     namespace Item {
         /**
@@ -224,10 +351,6 @@ export declare namespace List {
              * An optional subtitle displayed next to the main title.
              */
             subtitle?: string;
-            /**
-             * An additional title displayed for the item.
-             */
-            accessoryTitle?: string;
             /**
              * An optional property used for providing additional indexable strings for search.
              * When filtering the list in Raycast through the search bar, the keywords will be searched in addition to the title.
@@ -241,10 +364,35 @@ export declare namespace List {
              * A optional icon displayed as accessory for the list item.
              */
             accessoryIcon?: Image.ImageLike;
+            /**
+             * An additional title displayed for the item.
+             */
+            accessoryTitle?: string;
             /**
              * An {@link ActionPanel} that will be updated for the selected list item.
              */
             actions?: ReactNode | null;
+            /**
+             * The `List.Item.Detail` to be rendered in the right side area when the parent List is showing details and the item is selected.
+             */
+            detail?: ReactNode;
+        }
+        namespace Detail {
+            /**
+             * Props of the {@link List.Item.Detail} React component.
+             */
+            interface Props {
+                /**
+                 * Indicates whether a loading bar should be shown or hidden above the detail
+                 *
+                 * @defaultValue false
+                 */
+                isLoading?: boolean;
+                /**
+                 * The CommonMark string to be rendered in the right side area when the parent List is showing details and the item is selected.
+                 */
+                markdown?: string | null;
+            }
         }
     }
     namespace Section {
@@ -271,5 +419,161 @@ export declare namespace List {
             subtitle?: string;
         }
     }
+    namespace Dropdown {
+        /**
+         * Props of the {@link List.Dropdown} React component.
+         */
+        interface Props {
+            /**
+             * ID of the dropdown.
+             */
+            id?: string;
+            /**
+             * Tooltip displayed when hovering the dropdown.
+             */
+            tooltip: string;
+            /**
+             * Placeholder text that will be shown in the dropdown search field.
+             *
+             * @defaultValue Search...
+             */
+            placeholder?: string;
+            /**
+             * Indicates whether the value of the dropdown should be persisted after selection, and restored next time the dropdown is rendered.
+             */
+            storeValue?: boolean;
+            /**
+             * The currently value of the dropdown.
+             */
+            value?: string;
+            /**
+             * The default value of the dropdown.
+             * Keep in mind that `defaultValue` will be configured once per component lifecycle. This means that if a user changes the value, `defaultValue` won't be configured on re-rendering.
+             * @important If you're using `storeValue` and configured it as `true` _and_ a {@link List.Dropdown.Item} with the same value exists, then it will be selected.
+             * @important If you configure `value` at the same time as `defaultValue`, the `value` will have precedence over `defaultValue`.
+             */
+            defaultValue?: string;
+            /**
+             * List sections or items. If {@link List.Dropdown.Item} elements are specified, a default section is automatically created.
+             */
+            children?: ReactNode;
+            /**
+             * Callback triggered when the list item selection changes.
+             */
+            onChange?: (newValue: string) => void;
+        }
+        namespace Section {
+            /**
+             * Props of the {@link List.Dropdown.Section} React component.
+             */
+            interface Props {
+                /**
+                 * The item elements of the section.
+                 */
+                children?: ReactNode;
+                /**
+                 * Title displayed above the section
+                 */
+                title?: string;
+            }
+        }
+        namespace Item {
+            /**
+             * Props of the {@link List.Dropdown.Item} React component.
+             */
+            interface Props {
+                /**
+                 * Value of the dropdown item.
+                 * Make sure to assign each unique value for each item.
+                 */
+                value: string;
+                /**
+                 * The title displayed for the item.
+                 */
+                title: string;
+                /**
+                 * A optional icon displayed for the item.
+                 */
+                icon?: Image.ImageLike;
+            }
+        }
+    }
+}
+declare namespace ListDropdown {
+    /**
+     * Visually separated group of dropdown items in a {@link List.Dropdown}.
+     *
+     * @remarks
+     * Use sections to group related dropdown items together.
+     *
+     * @example
+     * ```typescript
+     * import { List } from "@raycast/api";
+     *
+     * export default function Command() {
+     *   return (
+     *     <List searchBarAccessory={
+     *       <List.Dropdown tooltip="Dropdown With Sections">
+     *         <List.Dropdown.Section title="First Section">
+     *           <List.Dropdown.Item title="One" value="one" />
+     *         </List.Dropdown.Section>
+     *         <List.Dropdown.Section title="Second Section">
+     *           <List.Dropdown.Item title="Two" value="two" />
+     *         </List.Dropdown.Section>
+     *       </List.Dropdown>
+     *     }>
+     *       <List.Item title="Item in the Main List">
+     *     </List>
+     *   );
+     * }
+     * ```
+     */
+    const Section: typeof ListDropdownSection;
+    /**
+     * A dropdown item in a {@link List.Dropdown}
+     *
+     * @example
+     * ```typescript
+     * import { List } from "@raycast/api";
+     *
+     * export default function Command() {
+     *     return (
+     *       <List searchBarAccessory={
+     *         <List.Dropdown tooltip="Dropdown With Items">
+     *           <List.Dropdown.Item title="One" value="one" />
+     *           <List.Dropdown.Item title="Two" value="two" />
+     *           <List.Dropdown.Item title="Three" value="three" />
+     *         </List.Dropdown>
+     *       }>
+     *         <List.Item title="Item in the Main List">
+     *       </List>
+     *   );
+     * }
+     * ```
+     */
+    const Item: typeof ListDropdownItem;
+}
+declare namespace ListItem {
+    /**
+     * A Detail view that will be shown in the right-hand-side of the List.
+     *
+     * @example
+     * ```typescript
+     * import { List } from "@raycast/api";
+     *
+     * export default function Command() {
+     *   return (
+     *     <List isShowingDetail>
+     *       <List.Item
+     *         title="Pikachu"
+     *         subtitle="Electric"
+     *         detail={<List.Item.Detail markdown="![Illustration](https://raw.githubusercontent.com/PokeAPI/sprites/master/sprites/pokemon/25.png)" />}
+     *       />
+     *     </List>
+     *   );
+     * }
+     * ```
+     */
+    const Detail: typeof ListItemDetail;
 }
 export {};

package/types/api/components/actions/Action.d.ts

@@ -378,6 +378,10 @@ export declare namespace Action {
         icon?: Image.ImageLike;
         /**
          * The keyboard shortcut for the item.
+         *
+         * @remarks
+         * The first and second action in an {@link ActionPanel} become the primary and secondary action. They automatically get the default keyboard shortcuts assigned.
+         * In {@link List} and {@link Detail}, this is `↵` for the primary and `⌘` `↵` for the secondary action. In {@link Form} it's `⌘` `↵` for the primary and `⌘` `⇧` `↵` for the secondary.
          */
         shortcut?: Keyboard.Shortcut;
         /**

package/types/api/deprecated.d.ts

@@ -1,6 +1,7 @@
+import { ReactNode } from "react";
 import { Clipboard, Keyboard, LocalStorage } from "./app";
 import { Action, ActionPanel, Form, List, Detail } from "./components";
-import { randomId as _randomId, useId as _useId, useActionPanel as _useActionPanel, ActionPanelState as _ActionPanelState, render as _render } from "./internal";
+import { randomId as _randomId, useId as _useId, render as _render } from "./internal";
 import { Alert, Toast as _Toast, Image, Color } from "./ui";
 import { Preference as _Preference, Preferences as _Preferences } from "../core/preferences";
 /*********************************
@@ -346,11 +347,15 @@ export declare const useId: typeof _useId;
 /**
  * @deprecated
  */
-export declare const useActionPanel: typeof _useActionPanel;
+export declare function useActionPanel(): ActionPanelState;
 /**
  * @deprecated
  */
-export interface ActionPanelState extends _ActionPanelState {
+export interface ActionPanelState {
+    /**
+     * @deprecated
+     */
+    update: (actionPanel: ReactNode) => void;
 }
 /**
  * @deprecated Use `Alert.Options` instead

package/types/api/internal/components/index.d.ts

@@ -1,4 +1,3 @@
-export * from "./portal";
 export * from "./ErrorBoundary";
 export * from "./Navigation";
 export * from "./Root";

package/types/api/internal/devtools/index.d.ts

@@ -1 +1,2 @@
 export * from "./react";
+export * from "./actionPanel";

package/types/api/internal/hooks/index.d.ts

@@ -1,2 +1 @@
 export * from "./useId";
-export * from "./useActionPanel";

package/types/api/internal/rendering/logger.d.ts

@@ -1 +1,4 @@
-export {};
+export declare function reactRenderDebugLog(...params: unknown[]): void;
+export declare function reconcilerDebugLog(...params: unknown[]): void;
+export declare function benchmarkingStart(label?: string): void;
+export declare function benchmarkingStop(label?: string): void;

package/types/api/internal/rendering/node-builders/detail.d.ts

@@ -1 +1,2 @@
-export {};
+import { RaycastElement } from "./types";
+export declare function appendDetailChildElement(detailElement: RaycastElement, childElement: RaycastElement): void;

package/types/api/internal/rendering/node-builders/forms.d.ts

@@ -1 +1,2 @@
-export {};
+import { RaycastElement } from "./types";
+export declare function appendFormChildElement(formElement: RaycastElement, childElement: RaycastElement): void;

package/types/api/internal/rendering/node-builders/list.d.ts

@@ -1,2 +1,4 @@
 import { RaycastElement } from "./types";
 export declare function appendListChildElement(listElement: RaycastElement, childElement: RaycastElement): void;
+export declare function appendListDropdownChildElement(listElement: RaycastElement, childElement: RaycastElement): void;
+export declare function appendListItemChildElement(listItemElement: RaycastElement, childElement: RaycastElement): void;

package/types/api/internal/rendering/node-builders/types.d.ts

@@ -1 +1 @@
-export {};
+export declare const AllPropsFromChildren: PropsFromChildren[];

package/types/api/internal/rendering/reconciler/noHydratation.d.ts

@@ -0,0 +1,37 @@
+declare function shim(): any;
+export declare const supportsHydration = false;
+export declare const canHydrateInstance: typeof shim;
+export declare const canHydrateTextInstance: typeof shim;
+export declare const canHydrateSuspenseInstance: typeof shim;
+export declare const isSuspenseInstancePending: typeof shim;
+export declare const isSuspenseInstanceFallback: typeof shim;
+export declare const registerSuspenseInstanceRetry: typeof shim;
+export declare const getNextHydratableSibling: typeof shim;
+export declare const getFirstHydratableChild: typeof shim;
+export declare const getFirstHydratableChildWithinContainer: typeof shim;
+export declare const getFirstHydratableChildWithinSuspenseInstance: typeof shim;
+export declare const hydrateInstance: typeof shim;
+export declare const hydrateTextInstance: typeof shim;
+export declare const hydrateSuspenseInstance: typeof shim;
+export declare const getNextHydratableInstanceAfterSuspenseInstance: typeof shim;
+export declare const commitHydratedContainer: typeof shim;
+export declare const commitHydratedSuspenseInstance: typeof shim;
+export declare const clearSuspenseBoundary: typeof shim;
+export declare const clearSuspenseBoundaryFromContainer: typeof shim;
+export declare const shouldDeleteUnhydratedTailInstances: typeof shim;
+export declare const didNotMatchHydratedContainerTextInstance: typeof shim;
+export declare const didNotMatchHydratedTextInstance: typeof shim;
+export declare const didNotHydrateInstanceWithinContainer: typeof shim;
+export declare const didNotHydrateInstanceWithinSuspenseInstance: typeof shim;
+export declare const didNotHydrateInstance: typeof shim;
+export declare const didNotFindHydratableInstanceWithinContainer: typeof shim;
+export declare const didNotFindHydratableTextInstanceWithinContainer: typeof shim;
+export declare const didNotFindHydratableSuspenseInstanceWithinContainer: typeof shim;
+export declare const didNotFindHydratableInstanceWithinSuspenseInstance: typeof shim;
+export declare const didNotFindHydratableTextInstanceWithinSuspenseInstance: typeof shim;
+export declare const didNotFindHydratableSuspenseInstanceWithinSuspenseInstance: typeof shim;
+export declare const didNotFindHydratableInstance: typeof shim;
+export declare const didNotFindHydratableTextInstance: typeof shim;
+export declare const didNotFindHydratableSuspenseInstance: typeof shim;
+export declare const errorHydratingContainer: typeof shim;
+export {};

package/types/api/internal/rendering/reconciler/noMutation.d.ts

@@ -0,0 +1,18 @@
+declare function shim(): any;
+export declare const supportsMutation = false;
+export declare const appendChild: typeof shim;
+export declare const appendChildToContainer: typeof shim;
+export declare const commitTextUpdate: typeof shim;
+export declare const commitMount: typeof shim;
+export declare const commitUpdate: typeof shim;
+export declare const insertBefore: typeof shim;
+export declare const insertInContainerBefore: typeof shim;
+export declare const removeChild: typeof shim;
+export declare const removeChildFromContainer: typeof shim;
+export declare const resetTextContent: typeof shim;
+export declare const hideInstance: typeof shim;
+export declare const hideTextInstance: typeof shim;
+export declare const unhideInstance: typeof shim;
+export declare const unhideTextInstance: typeof shim;
+export declare const clearContainer: typeof shim;
+export {};

package/types/api/internal/utils/index.d.ts

@@ -1 +1,3 @@
 export * from "./ids";
+export * from "./internal-children";
+export * from "./propTypes";

package/types/api/internal/utils/internal-children.d.ts

@@ -0,0 +1,26 @@
+import { ReactNode } from "react";
+import { RaycastElement } from "../rendering/node-builders/types";
+/**
+ * Users are expected to pass some components as props.
+ * However, because internally we take that prop and pass it as a child (to go throught the react reconciler),
+ * it means that a user could also pass the component as a child instead of using the prop.
+ *
+ * To circumvent this, in development mode we wrap the components passed as a prop with an `internal` flag context;
+ *
+ * Components that can be "internal" must listen to this context and pass it as a prop so that during
+ * reconciliation, if the flag is falsy the component is not added to the render tree and a warning is printed.
+ */
+export declare const InternalChildContext: import("react").Context<boolean>;
+/**
+ * Method to wrap a component prop with the internal dev flag
+ * @see {@link InternalChildContext}
+ */
+export declare function propToInternalChild(prop?: ReactNode): {};
+/**
+ * Check if the child has the internal flag set.
+ * Output a warning otherwise.
+ */
+export declare function internalChildInvariant(child: RaycastElement, warning: string): boolean;
+export declare type MaybeInternalComponent<T> = T & {
+    internal?: boolean;
+};

package/types/api/internal/utils/propTypes.d.ts

@@ -0,0 +1,3 @@
+declare function getPropType(propValue: unknown): "string" | "number" | "bigint" | "boolean" | "symbol" | "undefined" | "object" | "function" | "array";
+declare function getPreciseType(propValue: unknown): string;
+export { getPropType, getPreciseType };

package/types/api/internal/components/portal/components/portal/Portal.d.ts

@@ -1,4 +0,0 @@
-/// <reference types="react" />
-import type { PortalProps } from './types';
-declare const Portal: import("react").MemoExoticComponent<({ name: _providedName, hostName, handleOnMount, handleOnUnmount, children, }: PortalProps) => any>;
-export default Portal;

package/types/api/internal/components/portal/components/portal/index.d.ts

@@ -1 +0,0 @@
-export { default } from './Portal';

package/types/api/internal/components/portal/components/portalHost/PortalHost.d.ts

@@ -1,4 +0,0 @@
-import React from 'react';
-import type { PortalHostProps } from './types';
-declare const PortalHost: React.MemoExoticComponent<({ name }: PortalHostProps) => JSX.Element>;
-export default PortalHost;

package/types/api/internal/components/portal/components/portalHost/index.d.ts

@@ -1 +0,0 @@
-export { default } from './PortalHost';

package/types/api/internal/components/portal/components/portalProvider/PortalProvider.d.ts

@@ -1,4 +0,0 @@
-import React from 'react';
-import type { PortalProviderProps } from './types';
-declare const PortalProvider: React.MemoExoticComponent<({ children }: PortalProviderProps) => JSX.Element>;
-export default PortalProvider;

package/types/api/internal/components/portal/components/portalProvider/index.d.ts

@@ -1 +0,0 @@
-export { default } from './PortalProvider';

package/types/api/internal/components/portal/contexts/index.d.ts

@@ -1 +0,0 @@
-export { PortalDispatchContext, PortalStateContext } from './portal';

package/types/api/internal/components/portal/contexts/portal.d.ts

@@ -1,5 +0,0 @@
-/// <reference types="react" />
-import type { ActionTypes } from '../state';
-import type { PortalType } from '../types';
-export declare const PortalStateContext: import("react").Context<Record<string, PortalType[]>>;
-export declare const PortalDispatchContext: import("react").Context<import("react").Dispatch<ActionTypes>>;

package/types/api/internal/components/portal/hooks/index.d.ts

@@ -1,2 +0,0 @@
-export { usePortal } from './usePortal';
-export { usePortalState } from './usePortalState';

package/types/api/internal/components/portal/hooks/usePortal.d.ts

@@ -1,8 +0,0 @@
-import { ReactNode } from 'react';
-export declare const usePortal: (hostName?: string) => {
-    registerHost: () => void;
-    deregisterHost: () => void;
-    addPortal: (name: string, node: ReactNode) => void;
-    updatePortal: (name: string, node: ReactNode) => void;
-    removePortal: (name: string) => void;
-};

package/types/api/internal/components/portal/hooks/usePortalState.d.ts

@@ -1 +0,0 @@
-export declare const usePortalState: (hostName: string) => import("../types").PortalType[];

package/types/api/internal/components/portal/index.d.ts

@@ -1,5 +0,0 @@
-export { default as Portal } from './components/portal';
-export { default as PortalHost } from './components/portalHost';
-export { default as PortalProvider } from './components/portalProvider';
-export { usePortal } from './hooks/usePortal';
-export { enableLogging } from './utilities/logger';

package/types/api/internal/components/portal/state/constants.d.ts

@@ -1,9 +0,0 @@
-declare enum ACTIONS {
-    REGISTER_HOST = 0,
-    DEREGISTER_HOST = 1,
-    ADD_PORTAL = 2,
-    UPDATE_PORTAL = 3,
-    REMOVE_PORTAL = 4
-}
-declare const INITIAL_STATE: {};
-export { ACTIONS, INITIAL_STATE };

package/types/api/internal/components/portal/state/index.d.ts

@@ -1,3 +0,0 @@
-export { reducer } from './reducer';
-export { ACTIONS, INITIAL_STATE } from './constants';
-export type { ActionTypes } from './types';

package/types/api/internal/components/portal/state/reducer.d.ts

@@ -1,3 +0,0 @@
-import type { PortalType } from '../types';
-import type { ActionTypes } from './types';
-export declare const reducer: (state: Record<string, Array<PortalType>>, action: ActionTypes) => Record<string, PortalType[]>;

package/types/api/internal/components/portal/utilities/logger.d.ts

@@ -1,9 +0,0 @@
-interface PrintOptions {
-    component?: string;
-    method?: string;
-    params?: Record<string, any> | string | number | boolean;
-}
-declare type Print = (options: PrintOptions) => void;
-declare const enableLogging: () => void;
-declare let print: Print;
-export { print, enableLogging };