@dbx-tools/appkit-mastra 0.1.12 → 0.1.14

package/dist/src/genie.d.ts

@@ -1,131 +0,0 @@
-/**
- * Mastra tool wrappers around the AppKit `genie` plugin's exports.
- *
- * One `sendMessage` tool is registered per configured space alias so
- * the LLM picks the space by tool selection (the description bakes the
- * alias in). `getConversation` is registered once, taking `alias` as a
- * parameter.
- *
- * All Genie payload types are inferred from the public `genie` factory
- * (`genie().plugin` constructor → `exports()` return type), so any
- * upstream change in `@databricks/appkit` flows in automatically.
- *
- * As Genie streams its long-running events (`FETCHING_METADATA` →
- * `ASKING_AI` → `EXECUTING_QUERY` → `COMPLETED`, plus SQL text and
- * follow-ups in `message_result.attachments`), the tool forwards a
- * normalised {@link GenieProgress} discriminated union out through
- * `ctx.writer` so the client can render an incremental loading pill.
- * Row payloads from `query_result` are intentionally discarded - the
- * LLM never sees rows, and charts come from the separate
- * `render_data` tool when the model decides one is useful.
- */
-import { genie } from "@databricks/appkit";
-import { createTool } from "@mastra/core/tools";
-import type { MastraPluginConfig } from "./config.js";
-/** Live AppKit `GeniePlugin` instance. */
-export type GeniePluginInstance = InstanceType<ReturnType<typeof genie>["plugin"]>;
-/** Full `exports()` shape of the AppKit `genie` plugin. */
-export type GenieExports = ReturnType<GeniePluginInstance["exports"]>;
-/**
- * Stream event yielded by `genie.exports().sendMessage`. Discriminated
- * by `type` (`"message_start" | "status" | "message_result" |
- * "query_result" | "error" | "history_info"`).
- */
-export type GenieStreamEvent = ReturnType<GenieExports["sendMessage"]> extends AsyncGenerator<infer E> ? E : never;
-/** Conversation history returned by `genie.exports().getConversation`. */
-export type GenieConversation = Awaited<ReturnType<GenieExports["getConversation"]>>;
-/**
- * Normalised progress event surfaced to the UI as a Mastra
- * `tool-output` chunk. Loading pill events (`started`, `status`,
- * `sql`, `suggested`, `error`) are pure UI metadata and never reach
- * the LLM.
- *
- * The `chart` variant is the wire shape emitted by
- * {@link emitChartWithPlanning} (used by both this Genie
- * draining loop and the system-level `render_data` tool). All
- * fields except `chartId` are optional because two events per
- * chartId arrive on the wire: the first carries the rows
- * (`title` + `description?` + `data`); the second, on planner
- * success, carries just the resolved Echarts spec (`option`).
- * The host UI's `<ChartSlot>` merges them by `chartId`.
- */
-export type GenieProgress = {
-    kind: "started";
-    conversationId: string;
-    messageId: string;
-    spaceId: string;
-} | {
-    kind: "status";
-    status: string;
-    label: string;
-} | {
-    kind: "sql";
-    sql: string;
-    title?: string;
-    description?: string;
-    statementId?: string;
-} | {
-    kind: "chart";
-    chartId: string;
-    title?: string;
-    description?: string;
-    data?: Array<Record<string, unknown>>;
-    option?: Record<string, unknown>;
-} | {
-    kind: "text";
-    content: string;
-} | {
-    kind: "suggested";
-    questions: string[];
-} | {
-    kind: "error";
-    error: string;
-};
-/**
- * Default tool name for a wired Genie alias. The well-known `default`
- * alias collapses to `genie`; everything else gets a `genie_` prefix so
- * multiple spaces stay disambiguated when an agent has more than one
- * wired. Matches the `genie` / `genie_<alias>` naming used elsewhere in
- * dbx-tools AppKit demos.
- */
-export declare function defaultGenieToolName(alias: string): string;
-/**
- * Build one `sendMessage` tool per configured Genie alias plus a single
- * `getConversation` tool. Returns a record keyed by tool id, ready to
- * spread into an `Agent`'s `tools` map.
- *
- * `config` must be the active plugin config; Genie's
- * `query_result` events are routed through
- * {@link emitChartWithPlanning} which uses it to resolve the
- * chart-planner's model.
- */
-export declare function buildGenieTools(opts: {
-    aliases: string[];
-    exports: GenieExports;
-    config: MastraPluginConfig;
-    signal?: AbortSignal;
-}): Record<string, ReturnType<typeof createTool>>;
-/**
- * Toolkit provider built from a live AppKit `GeniePlugin` instance.
- * Returned by {@link buildGenieProvider} so that
- * `plugins.genie?.toolkit()` inside an agent's `tools(plugins)` callback
- * resolves to the streaming-aware {@link buildGenieTools} record instead
- * of the AppKit default (which does one blocking call per tool with no
- * mid-flight events).
- *
- * The returned `toolkit()` reads alias names off the plugin's
- * `getAgentTools()` registry (each entry is `${alias}.sendMessage` or
- * `${alias}.getConversation`), then mints one `sendMessage` tool per
- * alias plus a shared `getConversation`. `sendMessage` / `getConversation`
- * are bound back to the plugin instance so they keep their `this`
- * (they are class methods, not free functions).
- *
- * `_opts` is accepted but unused for now - the streaming tools are an
- * all-or-nothing bundle. Wire `only` / `except` / `prefix` / `rename`
- * later if a caller needs them.
- */
-export declare function buildGenieProvider(plugin: GeniePluginInstance, opts: {
-    config: MastraPluginConfig;
-}): {
-    toolkit(opts?: unknown): Record<string, ReturnType<typeof createTool>>;
-};