@tradalab/lyra 2.6.0 → 3.0.0

package/dist/blocks/index.d.ts

@@ -193,4 +193,225 @@ declare function OptionPicker({ value, onChange, options, labels, disabled, id,
     className?: string;
 }): React.JSX.Element;
 
-export { ConfirmContext, ConfirmDialog, type ConfirmFn, type ConfirmOptions, ConfirmProvider, Form, FormControl, FormDescription, FormField, FormItem, FormLabel, FormMessage, OptionPicker, type OptionPickerLabels, Panel, PanelCard, type PanelCardProps, type PanelItemProps, type PickOption, TreeExpander, type TreeExpanderProps, TreeIcon, type TreeIconProps, TreeLabel, type TreeLabelProps, TreeLines, TreeNode, TreeNodeContent, type TreeNodeContentProps, type TreeNodeProps, TreeNodeTrigger, type TreeNodeTriggerProps, TreeProvider, type TreeProviderProps, TreeView, type TreeViewProps, TzPicker, type TzPickerLabels, type TzPickerProps, useConfirm, useFormField };
+/**
+ * The settings screen for a scorix app's MCP tools: the user's switch, one switch per tool,
+ * the programs allowed in, and the calls as they happen.
+ *
+ * The api is INJECTED and its types are declared here, shaped like the `scorixMCP` that
+ * `scorix generate proto` emits, so an app passes that object as is. Importing scorix's types
+ * would put a desktop framework under the UI kit of every web app.
+ *
+ * `copy` is injected too, and without it there is no copy button: `navigator.clipboard` needs
+ * a secure context, which only WebView2 grants a scorix app. Reaching for it here would work
+ * on Windows and do nothing on macOS and Linux.
+ */
+interface McpTool {
+    name: string;
+    description: string;
+    destructive: boolean;
+    enabled: boolean;
+}
+interface McpClient {
+    path: string;
+    name?: string;
+    approved_at: string;
+}
+interface McpStatus {
+    offered: boolean;
+    enabled: boolean;
+    running: boolean;
+    tools: McpTool[];
+    clients: McpClient[];
+    client: {
+        command: string;
+        args: string[];
+    };
+    audit_log: string;
+}
+interface McpCall {
+    tool: string;
+    client: string;
+    client_path: string;
+    outcome: "ok" | "error" | "denied";
+    error?: string;
+    ms: number;
+}
+interface McpSettingsApi {
+    status(): Promise<McpStatus>;
+    enable(enabled: boolean): Promise<McpStatus>;
+    setTool(name: string, enabled: boolean): Promise<McpStatus>;
+    revokeClient(path: string): Promise<McpStatus>;
+    onCall?(cb: (call: McpCall) => void): () => void;
+}
+interface McpSettingsLabels {
+    enable?: string;
+    enableHint?: string;
+    running?: string;
+    stopped?: string;
+    notOffered?: string;
+    connect?: string;
+    connectHint?: string;
+    copy?: string;
+    copied?: string;
+    copyConfig?: string;
+    tools?: string;
+    toolsHint?: string;
+    asksFirst?: string;
+    asksFirstHint?: string;
+    clients?: string;
+    clientsHint?: string;
+    clientsEmpty?: string;
+    revoke?: string;
+    activity?: string;
+    activityEmpty?: string;
+    ok?: string;
+    error?: string;
+    denied?: string;
+    auditLog?: string;
+    auditLogHint?: string;
+    retry?: string;
+}
+declare function McpSettings({ api, serverName, copy, labels, locale, className, }: {
+    api: McpSettingsApi;
+    /** The key under `mcpServers` in the configuration snippet: the app's own short name. */
+    serverName: string;
+    copy?: (text: string) => Promise<void>;
+    labels?: McpSettingsLabels;
+    locale?: string;
+    className?: string;
+}): React.JSX.Element;
+
+/**
+ * The settings screen for a scorix app's language models: which provider and model each of the
+ * app's slots uses, the providers the user added with their keys, and downloads with progress.
+ *
+ * The api is INJECTED and its types are declared here, shaped like the JSON of scorix's
+ * `mod:llm:*` commands, so an app maps each method to one `invoke` call. Importing scorix's types
+ * would put a desktop framework under the UI kit of every web app.
+ *
+ * Keys never come back from the api: a provider lists which secret fields hold a value, and the
+ * form sends only the ones the user typed into or cleared.
+ */
+type LlmCapability = "chat" | "embed" | "vision" | "audio" | "tools" | "transcribe" | (string & {});
+interface LlmField {
+    key: string;
+    label: string;
+    kind: "text" | "url" | "secret" | "bool";
+    required: boolean;
+    default?: string;
+    description?: string;
+}
+interface LlmDriver {
+    name: string;
+    fields: LlmField[];
+}
+interface LlmProvider {
+    id: string;
+    /** Absent for a provider the app runs itself. */
+    driver?: string;
+    values: Record<string, string>;
+    /** The secret fields that hold a value; never the value. */
+    secrets: string[];
+    capabilities: LlmCapability[];
+    local: boolean;
+    /** Can download and delete models. */
+    manages: boolean;
+    editable: boolean;
+    error?: string;
+}
+interface LlmSlot {
+    name: string;
+    label: string;
+    description?: string;
+    needs: LlmCapability[];
+    local_only: boolean;
+    provider?: string;
+    model?: string;
+    error?: string;
+}
+interface LlmState {
+    providers: LlmProvider[];
+    slots: LlmSlot[];
+}
+interface LlmModel {
+    id: string;
+    size?: number;
+    parameter_size?: string;
+    quantization?: string;
+}
+interface LlmFound {
+    name: string;
+    driver: string;
+    base_url: string;
+    version?: string;
+}
+interface LlmProviderInput {
+    id: string;
+    driver: string;
+    values: Record<string, string>;
+    /** Only the secret fields being changed; an empty string removes one. */
+    secrets: Record<string, string>;
+}
+interface LlmPullProgress {
+    provider: string;
+    model: string;
+    status: string;
+    done: number;
+    total: number;
+}
+interface LlmSettingsApi {
+    state(): Promise<LlmState>;
+    drivers(): Promise<LlmDriver[]>;
+    saveProvider(input: LlmProviderInput): Promise<LlmState>;
+    deleteProvider(id: string): Promise<LlmState>;
+    bind(slot: string, provider: string, model: string): Promise<LlmState>;
+    unbind(slot: string): Promise<LlmState>;
+    models(provider: string): Promise<LlmModel[]>;
+    /** Without these three there is no download button. */
+    pull?(provider: string, model: string): Promise<boolean>;
+    cancelPull?(provider: string, model: string): Promise<boolean>;
+    onPull?(cb: (p: LlmPullProgress) => void): () => void;
+    /** Runtimes already running on this machine, offered as providers to add. */
+    detect?(): Promise<LlmFound[]>;
+}
+interface LlmSettingsLabels {
+    slots?: string;
+    slotsHint?: string;
+    notSet?: string;
+    model?: string;
+    modelHint?: string;
+    localOnly?: string;
+    localOnlyHint?: string;
+    download?: string;
+    notDownloaded?: string;
+    cancel?: string;
+    providers?: string;
+    providersHint?: string;
+    providersEmpty?: string;
+    add?: string;
+    edit?: string;
+    remove?: string;
+    removeConfirm?: string;
+    keep?: string;
+    byApp?: string;
+    thisMachine?: string;
+    remote?: string;
+    keySaved?: string;
+    driver?: string;
+    id?: string;
+    idHint?: string;
+    save?: string;
+    keyKeep?: string;
+    keyRemove?: string;
+    running?: string;
+    addFound?: string;
+    retry?: string;
+    capabilities?: Partial<Record<string, string>>;
+}
+declare function LlmSettings({ api, labels, className, }: {
+    api: LlmSettingsApi;
+    labels?: LlmSettingsLabels;
+    className?: string;
+}): React.JSX.Element;
+
+export { ConfirmContext, ConfirmDialog, type ConfirmFn, type ConfirmOptions, ConfirmProvider, Form, FormControl, FormDescription, FormField, FormItem, FormLabel, FormMessage, type LlmCapability, type LlmDriver, type LlmField, type LlmFound, type LlmModel, type LlmProvider, type LlmProviderInput, type LlmPullProgress, LlmSettings, type LlmSettingsApi, type LlmSettingsLabels, type LlmSlot, type LlmState, type McpCall, type McpClient, McpSettings, type McpSettingsApi, type McpSettingsLabels, type McpStatus, type McpTool, OptionPicker, type OptionPickerLabels, Panel, PanelCard, type PanelCardProps, type PanelItemProps, type PickOption, TreeExpander, type TreeExpanderProps, TreeIcon, type TreeIconProps, TreeLabel, type TreeLabelProps, TreeLines, TreeNode, TreeNodeContent, type TreeNodeContentProps, type TreeNodeProps, TreeNodeTrigger, type TreeNodeTriggerProps, TreeProvider, type TreeProviderProps, TreeView, type TreeViewProps, TzPicker, type TzPickerLabels, type TzPickerProps, useConfirm, useFormField };