@blastlauncher/runtime 1.0.5 → 3.0.0-alpha.1

package/README.md

@@ -1,11 +1,5 @@
-# `@blastlauncher/runtime`
-
-`@blastlauncher/runtime` is the runtime of Blast Launcher.
-
-In Raycast Launcher, you can build extensions in React.js. In Blast Launcher, we're taking this idea furthur. The **whole application** is build in React.js.
-
-The Launcher itself is a huge React.js application, and the extensions are also React.js components. Wrap components inside components, just regular React.js things, right?
-
-
-WIP WIP WIP WIP WIP
+# @blastlauncher/runtime
 
+Blast's runtime package.
+Emitted ESM and TypeScript declarations for Node.js 24.20+.
+See https://github.com/BlastLauncher/blast for documentation.

package/dist/api/action-panel.d.ts

@@ -0,0 +1,134 @@
+import { type ReactNode } from "react";
+import type { ImageLike, Shortcut } from "./types.js";
+export interface ActionPanelProps {
+    /** Sections or Actions. */
+    children?: ReactNode;
+    /** The title displayed at the top of the panel. */
+    title?: string;
+}
+export interface ActionPanelSectionProps {
+    /** Actions of the section. */
+    children?: ReactNode;
+    /** Title displayed above the section. */
+    title?: string;
+}
+/** `SubmenuProps` from the declarations (`ActionPanel.Submenu`). */
+export interface ActionPanelSubmenuProps {
+    /** @deprecated Internal prop; kept so legacy scenes round-trip their ids. */
+    id?: string;
+    /** The title displayed for the submenu. */
+    title: string;
+    /** The icon displayed for the submenu. */
+    icon?: ImageLike;
+    /** The keyboard shortcut for the submenu. */
+    shortcut?: Shortcut;
+    /** Items of the submenu: actions and sections. */
+    children?: ReactNode;
+    /** Callback that is triggered when the submenu is opened. */
+    onOpen?: () => void;
+    /**
+     * Indicates whether the submenu should be focused automatically when its
+     * parent ActionPanel (or submenu) opens.
+     */
+    autoFocus?: boolean;
+    /**
+     * Toggles filtering of the submenu's search bar; `false` (or a
+     * `keepSectionOrder` object) hands filtering to the extension.
+     */
+    filtering?: boolean | {
+        keepSectionOrder: boolean;
+    };
+    /** Indicates whether a loading indicator should be shown. */
+    isLoading?: boolean;
+    /** Throttles `onSearchTextChange` events. */
+    throttle?: boolean;
+    /** Callback triggered when the submenu's search bar text changes. */
+    onSearchTextChange?: (text: string) => void;
+}
+declare function ActionPanelSection(props: ActionPanelSectionProps): import("react").DOMElement<ActionPanelSectionProps, Element>;
+declare function Submenu(props: ActionPanelSubmenuProps): import("react").DOMElement<ActionPanelSubmenuProps, Element>;
+export declare const ActionPanel: ((props: ActionPanelProps) => import("react").DOMElement<ActionPanelProps, Element>) & {
+    Section: typeof ActionPanelSection;
+    Submenu: typeof Submenu;
+    Item: ((props: import("./action.js").ActionProps) => import("react").ReactElement<import("./action.js").ActionProps, string | import("react").JSXElementConstructor<any>>) & {
+        CopyToClipboard: typeof import("./action.js").CopyToClipboard;
+        CreateQuicklink: typeof import("./action.js").CreateQuicklink;
+        CreateSnippet: typeof import("./action.js").CreateSnippet;
+        InstallMCPServer: typeof import("./action.js").InstallMCPServer;
+        Open: typeof import("./action.js").Open;
+        OpenInBrowser: typeof import("./action.js").OpenInBrowser;
+        OpenWith: typeof import("./action.js").OpenWith;
+        Paste: typeof import("./action.js").Paste;
+        PickDate: ((props: import("./action.js").PickDateProps) => import("react").ReactElement<{
+            title: string;
+            shortcut?: Shortcut;
+            type?: import("./action.js").DatePickerTypeValue;
+            icon: ImageLike;
+            onChange: (value: import("@blastlauncher/protocol").JsonValue) => void;
+            min?: string;
+            max?: string;
+        }, string | import("react").JSXElementConstructor<any>>) & {
+            Type: {
+                readonly Date: "date";
+                readonly DateTime: "date_time";
+            };
+            isFullDay: (date?: Date | null) => boolean;
+        };
+        Push: typeof import("./action.js").Push;
+        ShowInFinder: typeof import("./action.js").ShowInFinder;
+        SubmitForm: typeof import("./form.js").SubmitForm;
+        ToggleQuickLook: typeof import("./action.js").ToggleQuickLook;
+        Trash: typeof import("./action.js").Trash;
+        Style: {
+            readonly Regular: "regular";
+            readonly Destructive: "destructive";
+        };
+    };
+};
+/** Deprecated top-level alias of `Action`. */
+export declare const ActionPanelItem: ((props: import("./action.js").ActionProps) => import("react").ReactElement<import("./action.js").ActionProps, string | import("react").JSXElementConstructor<any>>) & {
+    CopyToClipboard: typeof import("./action.js").CopyToClipboard;
+    CreateQuicklink: typeof import("./action.js").CreateQuicklink;
+    CreateSnippet: typeof import("./action.js").CreateSnippet;
+    InstallMCPServer: typeof import("./action.js").InstallMCPServer;
+    Open: typeof import("./action.js").Open;
+    OpenInBrowser: typeof import("./action.js").OpenInBrowser;
+    OpenWith: typeof import("./action.js").OpenWith;
+    Paste: typeof import("./action.js").Paste;
+    PickDate: ((props: import("./action.js").PickDateProps) => import("react").ReactElement<{
+        title: string;
+        shortcut?: Shortcut;
+        type?: import("./action.js").DatePickerTypeValue;
+        icon: ImageLike;
+        onChange: (value: import("@blastlauncher/protocol").JsonValue) => void;
+        min?: string;
+        max?: string;
+    }, string | import("react").JSXElementConstructor<any>>) & {
+        Type: {
+            readonly Date: "date";
+            readonly DateTime: "date_time";
+        };
+        isFullDay: (date?: Date | null) => boolean;
+    };
+    Push: typeof import("./action.js").Push;
+    ShowInFinder: typeof import("./action.js").ShowInFinder;
+    SubmitForm: typeof import("./form.js").SubmitForm;
+    ToggleQuickLook: typeof import("./action.js").ToggleQuickLook;
+    Trash: typeof import("./action.js").Trash;
+    Style: {
+        readonly Regular: "regular";
+        readonly Destructive: "destructive";
+    };
+};
+/** Deprecated top-level alias of `ActionPanel.Submenu`. */
+export declare const ActionPanelSubmenu: typeof Submenu;
+/** `ActionPanelState`: what the deprecated `useActionPanel` returns. */
+export interface ActionPanelState {
+    /** @deprecated No alternative :( */
+    update: (actionPanel: ReactNode) => void;
+}
+/** The last panel installed through `useActionPanel().update`. */
+export declare function currentActionPanel(): ReactNode;
+/** @deprecated No alternative :( */
+export declare function useActionPanel(): ActionPanelState;
+export {};

package/dist/api/action-panel.js

@@ -0,0 +1,36 @@
+import { createElement, useMemo } from "react";
+import { Action } from "./action.js";
+function ActionPanelSection(props) {
+    return createElement("ActionPanel.Section", props);
+}
+// `onOpen` and `onSearchTextChange` serialize as handler references, so
+// clients can dispatch a submenu opening (the CLI's `submenu <title>` script
+// command) and search text through the scene.
+function Submenu(props) {
+    return createElement("ActionPanel.Submenu", props);
+}
+export const ActionPanel = Object.assign(function ActionPanel(props) {
+    return createElement("ActionPanel", props);
+}, 
+// `ActionPanel.Item` is the deprecated name of `Action` (`typeof Action`).
+{ Section: ActionPanelSection, Submenu, Item: Action });
+/** Deprecated top-level alias of `Action`. */
+export const ActionPanelItem = Action;
+/** Deprecated top-level alias of `ActionPanel.Submenu`. */
+export const ActionPanelSubmenu = Submenu;
+// Raycast's legacy hook kept one action panel per view; Blast keeps the last
+// panel a command installed so `update` (and any code reading it back) is not
+// silently discarded. Views pick their panel from props in the scene model.
+let legacyActionPanel = null;
+/** The last panel installed through `useActionPanel().update`. */
+export function currentActionPanel() {
+    return legacyActionPanel;
+}
+/** @deprecated No alternative :( */
+export function useActionPanel() {
+    return useMemo(() => ({
+        update: (actionPanel) => {
+            legacyActionPanel = actionPanel;
+        },
+    }), []);
+}

package/dist/api/action.d.ts

@@ -0,0 +1,386 @@
+import { type ReactNode } from "react";
+import { type ClipboardContent } from "./clipboard.js";
+import { SubmitForm } from "./form.js";
+import { ActionStyle, DatePickerType_2, Icon } from "./enums.generated.js";
+import { type Application } from "./open.js";
+import type { ImageLike, Shortcut } from "./types.js";
+import type { JsonValue } from "../reconciler/index.js";
+export type ActionStyle = (typeof ActionStyle)[keyof typeof ActionStyle];
+export interface ActionProps {
+    /** @deprecated Internal prop; kept so legacy scenes round-trip their ids. */
+    id?: string;
+    /** The title displayed for the Action. */
+    title: string;
+    /** The icon displayed for the Action. */
+    icon?: ImageLike;
+    /** Defines the visual style of the Action. */
+    style?: ActionStyle;
+    /** The keyboard shortcut for the Action. */
+    shortcut?: Shortcut;
+    /**
+     * Indicates whether the Action should be focused automatically when its
+     * ActionPanel opens.
+     */
+    autoFocus?: boolean;
+    /** Callback that is triggered when the Action is selected. */
+    onAction?: () => void;
+}
+export interface CopyToClipboardProps {
+    /** The contents that will be copied to the clipboard. */
+    content: string | number | ClipboardContent;
+    /** An optional title for the Action. @defaultValue `"Copy to Clipboard"` */
+    title?: string;
+    /** An optional icon displayed for the Action. */
+    icon?: ImageLike;
+    /** The keyboard shortcut for the Action. */
+    shortcut?: Shortcut;
+    /** @deprecated Use `concealed` instead. */
+    transient?: boolean;
+    /** Indicates whether the content should be treated as confidential. */
+    concealed?: boolean;
+    /** Callback when the content was copied to clipboard. */
+    onCopy?: (content: string | number | ClipboardContent) => void;
+}
+/** The value type of `Action.PickDate.Type`. */
+export type DatePickerTypeValue = (typeof DatePickerType_2)[keyof typeof DatePickerType_2];
+/** `PickDateProps` from the declarations (`Action.PickDate`). */
+export interface PickDateProps {
+    /** A title for the Action. */
+    title: string;
+    /** The icon displayed for the Action. @defaultValue `Icon.Calendar` */
+    icon?: ImageLike;
+    /** The keyboard shortcut for the Action. */
+    shortcut?: Shortcut;
+    /** Callback when the date was picked. */
+    onChange: (date: Date | null) => void;
+    /** What types of date components can be picked. @defaultValue `Type.DateTime` */
+    type?: DatePickerTypeValue;
+    /** The minimum date (inclusive) allowed for selection. */
+    min?: Date;
+    /** The maximum date (inclusive) allowed for selection. */
+    max?: Date;
+}
+declare function isFullDay(date?: Date | null): boolean;
+export declare const PickDate: ((props: PickDateProps) => import("react").ReactElement<{
+    /** A title for the Action. */
+    title: string;
+    /** The keyboard shortcut for the Action. */
+    shortcut?: Shortcut;
+    /** What types of date components can be picked. @defaultValue `Type.DateTime` */
+    type?: DatePickerTypeValue;
+    icon: ImageLike;
+    onChange: (value: JsonValue) => void;
+    min?: string;
+    max?: string;
+}, string | import("react").JSXElementConstructor<any>>) & {
+    Type: {
+        readonly Date: "date";
+        readonly DateTime: "date_time";
+    };
+    isFullDay: typeof isFullDay;
+};
+export declare const Action: ((props: ActionProps) => import("react").ReactElement<ActionProps, string | import("react").JSXElementConstructor<any>>) & {
+    CopyToClipboard: typeof CopyToClipboard;
+    CreateQuicklink: typeof CreateQuicklink;
+    CreateSnippet: typeof CreateSnippet;
+    InstallMCPServer: typeof InstallMCPServer;
+    Open: typeof Open;
+    OpenInBrowser: typeof OpenInBrowser;
+    OpenWith: typeof OpenWith;
+    Paste: typeof Paste;
+    PickDate: ((props: PickDateProps) => import("react").ReactElement<{
+        /** A title for the Action. */
+        title: string;
+        /** The keyboard shortcut for the Action. */
+        shortcut?: Shortcut;
+        /** What types of date components can be picked. @defaultValue `Type.DateTime` */
+        type?: DatePickerTypeValue;
+        icon: ImageLike;
+        onChange: (value: JsonValue) => void;
+        min?: string;
+        max?: string;
+    }, string | import("react").JSXElementConstructor<any>>) & {
+        Type: {
+            readonly Date: "date";
+            readonly DateTime: "date_time";
+        };
+        isFullDay: typeof isFullDay;
+    };
+    Push: typeof Push;
+    ShowInFinder: typeof ShowInFinder;
+    SubmitForm: typeof SubmitForm;
+    ToggleQuickLook: typeof ToggleQuickLook;
+    Trash: typeof Trash;
+    Style: {
+        readonly Regular: "regular";
+        readonly Destructive: "destructive";
+    };
+};
+export declare function CopyToClipboard(props: CopyToClipboardProps): import("react").ReactElement<{
+    /** An optional icon displayed for the Action. */
+    icon?: ImageLike;
+    /** The keyboard shortcut for the Action. */
+    shortcut?: Shortcut;
+    /** Indicates whether the content should be treated as confidential. */
+    concealed?: boolean;
+    title: string;
+    onAction: () => Promise<void | undefined>;
+}, string | import("react").JSXElementConstructor<any>>;
+export interface OpenInBrowserProps {
+    url: string;
+    title?: string;
+    icon?: ImageLike;
+    shortcut?: Shortcut;
+    onOpen?: (url: string) => void;
+}
+export interface PasteProps {
+    content: string | number | ClipboardContent;
+    title?: string;
+    icon?: ImageLike;
+    shortcut?: Shortcut;
+    onPaste?: (content: string | number | ClipboardContent) => void;
+}
+export declare function OpenInBrowser(props: OpenInBrowserProps): import("react").ReactElement<{
+    shortcut?: Shortcut;
+    title: string;
+    icon: ImageLike;
+    onAction: () => Promise<void>;
+}, string | import("react").JSXElementConstructor<any>>;
+export declare function Paste(props: PasteProps): import("react").ReactElement<{
+    shortcut?: Shortcut;
+    title: string;
+    icon: ImageLike;
+    onAction: () => Promise<void>;
+}, string | import("react").JSXElementConstructor<any>>;
+export { CopyToClipboard as CopyToClipboardAction, Paste as PasteAction };
+export interface PushProps {
+    title: string;
+    target: ReactNode;
+    icon?: ImageLike;
+    shortcut?: Shortcut;
+    onPush?: () => void;
+    onPop?: () => void;
+}
+export declare function Push({ target, onPush, onPop, ...props }: PushProps): import("react").ReactElement<{
+    title: string;
+    icon?: ImageLike;
+    shortcut?: Shortcut;
+    onAction: () => void;
+}, string | import("react").JSXElementConstructor<any>>;
+export { Push as PushAction };
+/** `PathLike`, which the declarations take from `node:fs`. */
+export type ActionPathLike = string | Buffer | URL;
+/** `OpenProps` from the declarations (`Action.Open`). */
+export interface OpenProps {
+    /** The file, folder or URL to open. */
+    target: string;
+    /** The application name (or identifier/path) to use for opening the file. */
+    application?: Application | string;
+    /** The title for the Action. */
+    title: string;
+    /** The icon displayed for the Action. @defaultValue `Icon.Finder` */
+    icon?: ImageLike;
+    /** The keyboard shortcut for the Action. */
+    shortcut?: Shortcut;
+    /** Callback when the file or folder was opened. */
+    onOpen?: (target: string) => void;
+}
+export declare function Open(props: OpenProps): import("react").ReactElement<{
+    /** The title for the Action. */
+    title: string;
+    /** The keyboard shortcut for the Action. */
+    shortcut?: Shortcut;
+    icon: ImageLike;
+    onAction: () => Promise<void>;
+}, string | import("react").JSXElementConstructor<any>>;
+/** Deprecated alias of `Action.Open`. */
+export declare const OpenAction: typeof Open;
+/** `OpenWithProps` from the declarations (`Action.OpenWith`). */
+export interface OpenWithProps {
+    /** The path to open. */
+    path: string;
+    /** The title for the Action. @defaultValue `"Open With"` */
+    title?: string;
+    /** The icon displayed for the Action. @defaultValue `Icon.Upload` */
+    icon?: ImageLike;
+    /** The keyboard shortcut for the Action. */
+    shortcut?: Shortcut;
+    /** Callback when the file or folder was opened. */
+    onOpen?: (path: string) => void;
+}
+export declare function OpenWith(props: OpenWithProps): import("react").ReactElement<{
+    /** The keyboard shortcut for the Action. */
+    shortcut?: Shortcut;
+    title: string;
+    icon: ImageLike;
+    onAction: () => Promise<void>;
+}, string | import("react").JSXElementConstructor<any>>;
+/** Deprecated alias of `Action.OpenWith`. */
+export declare const OpenWithAction: typeof OpenWith;
+/** `ShowInFinderProps` from the declarations (`Action.ShowInFinder`). */
+export interface ShowInFinderProps {
+    /** The path to reveal. */
+    path: ActionPathLike;
+    /** The title for the Action. @defaultValue `"Show in Finder"` */
+    title?: string;
+    /** The icon displayed for the Action. @defaultValue `Icon.Finder` */
+    icon?: ImageLike;
+    /** The keyboard shortcut for the Action. */
+    shortcut?: Shortcut;
+    /** Callback when the file or folder was shown in the Finder. */
+    onShow?: (path: ActionPathLike) => void;
+}
+export declare function ShowInFinder(props: ShowInFinderProps): import("react").ReactElement<{
+    /** The keyboard shortcut for the Action. */
+    shortcut?: Shortcut;
+    title: string;
+    icon: ImageLike;
+    onAction: () => Promise<void>;
+}, string | import("react").JSXElementConstructor<any>>;
+/** Deprecated alias of `Action.ShowInFinder`. */
+export declare const ShowInFinderAction: typeof ShowInFinder;
+/** `TrashProps` from the declarations (`Action.Trash`). */
+export interface TrashProps {
+    /** The item or items to move to the trash. */
+    paths: ActionPathLike | ActionPathLike[];
+    /** The title for the Action. @defaultValue `"Move to Trash"` */
+    title?: string;
+    /** The icon displayed for the Action. @defaultValue `Icon.Trash` */
+    icon?: ImageLike;
+    /** The keyboard shortcut for the Action. */
+    shortcut?: Shortcut;
+    /** Callback when all items were moved to the trash. */
+    onTrash?: (paths: ActionPathLike | ActionPathLike[]) => void;
+}
+export declare function Trash(props: TrashProps): import("react").ReactElement<{
+    /** The keyboard shortcut for the Action. */
+    shortcut?: Shortcut;
+    title: string;
+    icon: ImageLike;
+    onAction: () => Promise<void>;
+}, string | import("react").JSXElementConstructor<any>>;
+/** Deprecated alias of `Action.Trash`. */
+export declare const TrashAction: typeof Trash;
+/** `Snippet` from the declarations. */
+export interface Snippet {
+    /** The snippet contents. */
+    text: string;
+    /** The snippet name. */
+    name?: string;
+    /** The keyword to trigger the snippet. */
+    keyword?: string;
+}
+/** `CreateSnippetProps` from the declarations (`Action.CreateSnippet`). */
+export interface CreateSnippetProps {
+    /** The snippet to create. */
+    snippet: Snippet;
+    /** The title for the Action. */
+    title?: string;
+    /** The icon displayed for the Action. */
+    icon?: ImageLike;
+    /** The keyboard shortcut for the Action. */
+    shortcut?: Shortcut;
+}
+export declare function CreateSnippet(props: CreateSnippetProps): import("react").ReactElement<{
+    /** The keyboard shortcut for the Action. */
+    shortcut?: Shortcut;
+    title: string;
+    icon: ImageLike;
+    onAction: () => Promise<JsonValue>;
+}, string | import("react").JSXElementConstructor<any>>;
+/** `Quicklink` from the declarations. */
+export interface Quicklink {
+    /** The icon to display for the quicklink. */
+    icon?: (typeof Icon)[keyof typeof Icon];
+    /** The URL or file path, optionally including placeholders such as `{Query}`. */
+    link: string;
+    /** The quicklink name. */
+    name?: string;
+    /** The application that the quicklink should be opened in. */
+    application?: string | Application;
+}
+/** `CreateQuicklinkProps` from the declarations (`Action.CreateQuicklink`). */
+export interface CreateQuicklinkProps {
+    /** The quicklink to create. */
+    quicklink: Quicklink;
+    /** The title for the Action. */
+    title?: string;
+    /** The icon displayed for the Action. */
+    icon?: ImageLike;
+    /** The keyboard shortcut for the Action. */
+    shortcut?: Shortcut;
+}
+export declare function CreateQuicklink(props: CreateQuicklinkProps): import("react").ReactElement<{
+    /** The keyboard shortcut for the Action. */
+    shortcut?: Shortcut;
+    title: string;
+    icon: ImageLike;
+    onAction: () => Promise<JsonValue>;
+}, string | import("react").JSXElementConstructor<any>>;
+/** `ToggleQuickLookProps` from the declarations (`Action.ToggleQuickLook`). */
+export interface ToggleQuickLookProps {
+    /** The title for the Action. @defaultValue `"Quick Look"` */
+    title?: string;
+    /** The icon displayed for the Action. @defaultValue `Icon.Eye` */
+    icon?: ImageLike;
+    /** The keyboard shortcut for the Action. */
+    shortcut?: Shortcut;
+}
+export declare function ToggleQuickLook(props: ToggleQuickLookProps): import("react").ReactElement<{
+    title: string;
+    icon: ImageLike;
+    shortcut: Shortcut | undefined;
+    onAction: () => Promise<JsonValue>;
+}, string | import("react").JSXElementConstructor<any>>;
+/** An `Icon` member, as the declarations type `MCPServer.icon`. */
+export type IconValue = (typeof Icon)[keyof typeof Icon];
+/** `MCPServer` from the declarations. */
+export interface MCPServer {
+    /** The icon to display for the MCP server. */
+    icon?: IconValue;
+    /** The name of the MCP server. */
+    name: string;
+    /** The description of the MCP server. */
+    description?: string;
+}
+/** `StdioMCPServer`: an MCP server started as a local process. */
+export interface StdioMCPServer extends MCPServer {
+    transport: "stdio";
+    /** The command to run the MCP server. */
+    command: string;
+    /** The arguments to pass to the MCP server. */
+    args?: string[];
+    /** The environment variables to pass to the MCP server. */
+    env?: Record<string, string>;
+}
+/** `SSEMCPServer`: an MCP server reached over HTTP. */
+export interface SSEMCPServer extends MCPServer {
+    transport: "sse";
+    /** The URL of the MCP server. */
+    url: string;
+    /** The HTTP headers to use for network requests to the MCP server. */
+    headers?: Record<string, string>;
+}
+/** `InstallMCPServerProps` from the declarations (`Action.InstallMCPServer`). */
+export interface InstallMCPServerProps {
+    /** The stdio or SSE server to install. */
+    server: StdioMCPServer | SSEMCPServer;
+    /** The title for the Action. */
+    title?: string;
+    /** The icon displayed for the Action. */
+    icon?: ImageLike;
+    /** The keyboard shortcut for the Action. */
+    shortcut?: Shortcut;
+}
+/**
+ * Installs an MCP server. Blast runs no MCP client, so this is a capability:
+ * the host decides, and a headless run denies it unless granted.
+ */
+export declare function InstallMCPServer(props: InstallMCPServerProps): import("react").ReactElement<{
+    /** The icon displayed for the Action. */
+    icon?: ImageLike;
+    /** The keyboard shortcut for the Action. */
+    shortcut?: Shortcut;
+    title: string;
+    onAction: () => Promise<void>;
+}, string | import("react").JSXElementConstructor<any>>;