@dbx-tools/genie 0.9.131 → 0.9.132

package/README.md

@@ -1,25 +1,26 @@
 # @dbx-tools/genie
 
-Server-side Databricks Genie chat drivers.
+Run Databricks Genie turns from Node or AppKit code as raw message snapshots or
+a typed event stream. AppKit requests keep their on-behalf-of-user (OBO)
+identity, standalone callers use the Databricks SDK authentication chain, and
+both modes support cancellation.
 
-Run a Genie turn from Node or AppKit code and consume raw message snapshots or a
-typed event stream. AppKit requests keep their OBO identity; standalone callers
-use the Databricks SDK authentication chain. Both modes support cancellation.
-
-## Quick Start
+## Quick start
 
 ```ts
 import { chat } from "@dbx-tools/genie";
 
+const spaceId = process.env.DATABRICKS_GENIE_SPACE_ID!;
+
 for await (const event of chat.genieEventChat(spaceId, "Top stores by revenue?")) {
   console.log(event.type, event);
 }
 ```
 
 Pure Genie schemas and event detector helpers live in
-[`@dbx-tools/shared-genie`](../../shared/genie).
+[@dbx-tools/shared-genie](../../shared/genie).
 
-Key features:
+The driver:
 
 - Streams the Genie Agent Mode API by default, including reasoning, SQL calls,
   query output, and the synthesized answer.
@@ -40,15 +41,17 @@ Key features:
   CLI tools.
 - Fetches Genie space metadata and starter questions for UI suggestions.
 
-## Choose The Driver Or AppKit Genie
+## Choose Genie integration
 
-Native AppKit's Genie plugin is the right choice for a standalone Genie chat
-experience: it provides named space aliases, SSE status updates, conversation
+Use native AppKit's Genie plugin for a standalone Genie chat experience. It
+provides named space aliases, SSE status updates, conversation
 history replay, query result fetching, OBO execution, and the AppKit UI
 `GenieChat` component.
 
-Use this package when Genie is one capability inside a larger agent or custom
-backend:
+Use direct Genie when one Genie space owns the conversation and answer. Use
+[@dbx-tools/appkit-mastra](../appkit-mastra) when a supervising agent must
+combine Genie with other tools, Mastra memory, approvals, or workflows. Use
+this package directly when custom backend code needs the lower-level stream:
 
 - You want a low-level async iterator rather than an AppKit HTTP route.
 - You want raw message snapshots or a normalized event stream that can be fed
@@ -60,7 +63,7 @@ backend:
 - You need the same driver to work inside AppKit with OBO auth and outside
   AppKit from scripts using normal Databricks SDK auth.
 
-## Handle Semantic Events
+## Handle semantic events
 
 ```ts
 import { chat } from "@dbx-tools/genie";
@@ -85,10 +88,10 @@ for await (const event of chat.genieEventChat(spaceId, "Top stores by revenue?")
 
 `chat.genieEventChat()` wraps the lower-level snapshot stream and yields a
 `GenieChatEvent` union. Use it for SSE streams, log pipelines, and tool writer
-events where consumers care about progress and SQL, not just the terminal
+events where consumers care about progress and SQL rather than only the terminal
 message.
 
-## Stream Raw Message Snapshots
+## Stream raw message snapshots
 
 ```ts
 import { chat } from "@dbx-tools/genie";
@@ -107,7 +110,7 @@ normalized wire shape. Agent Mode returns query output inline as Markdown and
 copies a query output's `statement_id` onto the matching query attachment when
 Databricks supplies one.
 
-## Continue A Conversation
+## Continue a conversation
 
 ```ts
 let conversationId: string | undefined;
@@ -126,7 +129,7 @@ message or event and passing it into the next turn. This works in stateless
 route handlers, durable thread stores, and one-off scripts. AppKit-Mastra stores
 the id with its thread and passes it back when a conversation continues.
 
-## Resolve A Workspace Client
+## Resolve a workspace client
 
 ```ts
 import { createWorkspaceClient } from "@databricks/appkit";
@@ -139,14 +142,14 @@ await chat.genieEventChat(spaceId, content, {
 
 Client resolution order:
 
-1. `options.workspaceClient`;
-2. AppKit execution-context client, when present;
-3. `createWorkspaceClient()` using AppKit's normal Databricks auth chain.
+1. `options.workspaceClient`.
+1. AppKit execution-context client, when present.
+1. `createWorkspaceClient()` using AppKit's normal Databricks auth chain.
 
 Pass `options.context` as an `AbortSignal` or SDK context to cancel the Agent
 Mode stream, SDK calls, and any polling fallback sleep.
 
-## Read Space Metadata And Starter Questions
+## Read space metadata and starter questions
 
 ```ts
 import { space } from "@dbx-tools/genie";
@@ -163,7 +166,7 @@ The serialized blob needs `Can Edit` on the space, while `Can Run` is enough for
 title and description. When the workspace rejects the serialized request for
 lack of permission, `getGenieSpace()` retries once without it and logs
 `serialized-space:forbidden`, so an app service principal holding only `Can Run`
-still resolves the space and simply reports no starter questions. Every other
+still resolves the space and reports no starter questions. Every other
 failure - a cancelled request, a missing space, a retry that also fails - is
 thrown.
 
@@ -172,9 +175,9 @@ thrown.
 `chat.GenieChatOptions` is shared by both drivers:
 
 - `conversationId` - append to an existing Genie conversation.
-- `agentMode` - use Agent Mode SSE, default `true`; `false` forces polling.
+- `agentMode` - use Agent Mode SSE, default `true`. `false` forces polling.
 - `agentModeFallback` - fall back to classic polling when Agent Mode is
-  unavailable, default `true`; direct Agent-only callers set `false`.
+  unavailable, default `true`. Direct Agent-only callers set `false`.
 - `enableVisualization` - request Agent Mode visualization generation.
 - `workspaceClient` - explicit Databricks SDK client.
 - `pollIntervalMs` - fallback polling cadence, default `500`.
@@ -188,6 +191,6 @@ thrown.
   Mode transport options plus Agent Mode conversation history.
 - `space` - `getGenieSpace()` and `genieSampleQuestions()`.
 
-The AppKit-Mastra package builds its Genie tools on top of this driver; see
-[`@dbx-tools/appkit-mastra`](../appkit-mastra) for the agent-level
+The AppKit-Mastra package builds its Genie tools on top of this driver. See
+[@dbx-tools/appkit-mastra](../appkit-mastra) for the agent-level
 workflow.

package/index.ts

@@ -3,7 +3,7 @@
 // Hand edits are overwritten on the next watch; this file is read-only.
 
 export const PACKAGE_IDENTIFIER = "@dbx-tools/genie";
-export const PACKAGE_VERSION = "0.9.131";
+export const PACKAGE_VERSION = "0.9.132";
 export * as agentMode from "./src/agent-mode.ts";
 export * as chat from "./src/chat.ts";
 export * as space from "./src/space.ts";

package/lib/index.d.ts

@@ -1,5 +1,5 @@
 export declare const PACKAGE_IDENTIFIER = "@dbx-tools/genie";
-export declare const PACKAGE_VERSION = "0.9.131";
+export declare const PACKAGE_VERSION = "0.9.132";
 export * as agentMode from "./src/agent-mode.ts";
 export * as chat from "./src/chat.ts";
 export * as space from "./src/space.ts";

package/lib/index.js

@@ -2,8 +2,8 @@
 // Regenerated from the exporting modules in ./src.
 // Hand edits are overwritten on the next watch; this file is read-only.
 export const PACKAGE_IDENTIFIER = "@dbx-tools/genie";
-export const PACKAGE_VERSION = "0.9.131";
+export const PACKAGE_VERSION = "0.9.132";
 export * as agentMode from "./src/agent-mode.js";
 export * as chat from "./src/chat.js";
 export * as space from "./src/space.js";
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSwyQ0FBMkM7QUFDM0MsbURBQW1EO0FBQ25ELHdFQUF3RTtBQUV4RSxNQUFNLENBQUMsTUFBTSxrQkFBa0IsR0FBRyxrQkFBa0IsQ0FBQztBQUNyRCxNQUFNLENBQUMsTUFBTSxlQUFlLEdBQUcsU0FBUyxDQUFDO0FBQ3pDLE9BQU8sS0FBSyxTQUFTLE1BQU0scUJBQXFCLENBQUM7QUFDakQsT0FBTyxLQUFLLElBQUksTUFBTSxlQUFlLENBQUM7QUFDdEMsT0FBTyxLQUFLLEtBQUssTUFBTSxnQkFBZ0IsQ0FBQyIsInNvdXJjZXNDb250ZW50IjpbIi8vIEdFTkVSQVRFRCBieSBwcm9qZW4gd2F0Y2ggLSBETyBOT1QgRURJVC5cbi8vIFJlZ2VuZXJhdGVkIGZyb20gdGhlIGV4cG9ydGluZyBtb2R1bGVzIGluIC4vc3JjLlxuLy8gSGFuZCBlZGl0cyBhcmUgb3ZlcndyaXR0ZW4gb24gdGhlIG5leHQgd2F0Y2g7IHRoaXMgZmlsZSBpcyByZWFkLW9ubHkuXG5cbmV4cG9ydCBjb25zdCBQQUNLQUdFX0lERU5USUZJRVIgPSBcIkBkYngtdG9vbHMvZ2VuaWVcIjtcbmV4cG9ydCBjb25zdCBQQUNLQUdFX1ZFUlNJT04gPSBcIjAuOS4xMzFcIjtcbmV4cG9ydCAqIGFzIGFnZW50TW9kZSBmcm9tIFwiLi9zcmMvYWdlbnQtbW9kZS50c1wiO1xuZXhwb3J0ICogYXMgY2hhdCBmcm9tIFwiLi9zcmMvY2hhdC50c1wiO1xuZXhwb3J0ICogYXMgc3BhY2UgZnJvbSBcIi4vc3JjL3NwYWNlLnRzXCI7XG5leHBvcnQgdHlwZSB7IEdlbmllQWdlbnRNb2RlT3B0aW9ucyB9IGZyb20gXCIuL3NyYy9hZ2VudC1tb2RlLnRzXCI7XG5leHBvcnQgdHlwZSB7IEdlbmllQ2hhdE9wdGlvbnMgfSBmcm9tIFwiLi9zcmMvY2hhdC50c1wiO1xuZXhwb3J0IHR5cGUgeyBHZXRHZW5pZVNwYWNlT3B0aW9ucyB9IGZyb20gXCIuL3NyYy9zcGFjZS50c1wiO1xuIl19
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSwyQ0FBMkM7QUFDM0MsbURBQW1EO0FBQ25ELHdFQUF3RTtBQUV4RSxNQUFNLENBQUMsTUFBTSxrQkFBa0IsR0FBRyxrQkFBa0IsQ0FBQztBQUNyRCxNQUFNLENBQUMsTUFBTSxlQUFlLEdBQUcsU0FBUyxDQUFDO0FBQ3pDLE9BQU8sS0FBSyxTQUFTLE1BQU0scUJBQXFCLENBQUM7QUFDakQsT0FBTyxLQUFLLElBQUksTUFBTSxlQUFlLENBQUM7QUFDdEMsT0FBTyxLQUFLLEtBQUssTUFBTSxnQkFBZ0IsQ0FBQyIsInNvdXJjZXNDb250ZW50IjpbIi8vIEdFTkVSQVRFRCBieSBwcm9qZW4gd2F0Y2ggLSBETyBOT1QgRURJVC5cbi8vIFJlZ2VuZXJhdGVkIGZyb20gdGhlIGV4cG9ydGluZyBtb2R1bGVzIGluIC4vc3JjLlxuLy8gSGFuZCBlZGl0cyBhcmUgb3ZlcndyaXR0ZW4gb24gdGhlIG5leHQgd2F0Y2g7IHRoaXMgZmlsZSBpcyByZWFkLW9ubHkuXG5cbmV4cG9ydCBjb25zdCBQQUNLQUdFX0lERU5USUZJRVIgPSBcIkBkYngtdG9vbHMvZ2VuaWVcIjtcbmV4cG9ydCBjb25zdCBQQUNLQUdFX1ZFUlNJT04gPSBcIjAuOS4xMzJcIjtcbmV4cG9ydCAqIGFzIGFnZW50TW9kZSBmcm9tIFwiLi9zcmMvYWdlbnQtbW9kZS50c1wiO1xuZXhwb3J0ICogYXMgY2hhdCBmcm9tIFwiLi9zcmMvY2hhdC50c1wiO1xuZXhwb3J0ICogYXMgc3BhY2UgZnJvbSBcIi4vc3JjL3NwYWNlLnRzXCI7XG5leHBvcnQgdHlwZSB7IEdlbmllQWdlbnRNb2RlT3B0aW9ucyB9IGZyb20gXCIuL3NyYy9hZ2VudC1tb2RlLnRzXCI7XG5leHBvcnQgdHlwZSB7IEdlbmllQ2hhdE9wdGlvbnMgfSBmcm9tIFwiLi9zcmMvY2hhdC50c1wiO1xuZXhwb3J0IHR5cGUgeyBHZXRHZW5pZVNwYWNlT3B0aW9ucyB9IGZyb20gXCIuL3NyYy9zcGFjZS50c1wiO1xuIl19

package/package.json

@@ -24,9 +24,9 @@
   },
   "dependencies": {
     "@databricks/appkit": "0.81.0",
-    "@dbx-tools/appkit": "^0.9.131",
-    "@dbx-tools/shared-core": "^0.9.131",
-    "@dbx-tools/shared-genie": "^0.9.131"
+    "@dbx-tools/appkit": "^0.9.132",
+    "@dbx-tools/shared-core": "^0.9.132",
+    "@dbx-tools/shared-genie": "^0.9.132"
   },
   "main": "./lib/index.js",
   "license": "Apache-2.0",
@@ -58,7 +58,7 @@
       "./package.json": "./package.json"
     }
   },
-  "version": "0.9.131",
+  "version": "0.9.132",
   "types": "./lib/index.d.ts",
   "dbxToolsConfig": {
     "tags": [