@dbx-tools/genie 0.1.27 → 0.1.28

package/dist/index.d.ts

@@ -1,33 +1,15 @@
 /**
  * `@dbx-tools/genie` public surface.
  *
- *   - {@link genieChat}: low-level async generator. Yields every
- *     poll-observed `GenieMessage` for a single turn against a
- *     Genie space. Multi-turn conversations are driven by the
- *     caller (thread the `conversation_id` off each yielded
- *     message into the next call's `options.conversationId`).
- *   - {@link genieEventChat}: high-level async generator. Drives
- *     `genieChat` and yields a strongly-typed
- *     {@link GenieChatEvent} stream of flat `{type, ...fields}`
- *     records (`message`, `status`, `attachment`, `thinking`,
- *     `text`, `query`, `statement`, `rows`,
- *     `suggested_questions`, `result`). The final yield for any
- *     terminal turn is always `{ type: "result", ... }`.
+ * Bundles the package's Node-side chat driver with a re-export of
+ * the pure `@dbx-tools/genie-shared` wire vocabulary so a single
+ * `from "@dbx-tools/genie"` import serves server-side consumers
+ * that need both the live driver and the protocol types.
  *
- * Wire-format types, the {@link GenieChatEvent} discriminated
- * union, per-event detectors (`detectStatus`, `detectThinking`,
- * `detectAttachmentAdded`, `detectText`, `detectQuery`,
- * `detectStatement`, `detectRows`, `detectSuggestedQuestions`),
- * the `eventsFromMessage` sync generator, and terminal-status
- * helpers all live in `@dbx-tools/genie-shared` and are
- * re-exported here so a single `from "@dbx-tools/genie"` import
- * works for server-side consumers. Browser-side consumers should
- * import from `@dbx-tools/genie-shared` directly to avoid pulling
- * in the Node-only `chat.ts` runtime.
- *
- * Browser safety: `chat.ts` pulls in `WorkspaceClient` and is
- * Node-only; the re-exports from `@dbx-tools/genie-shared` are
- * pure (types + sync functions) and safe for any runtime.
+ * Browser-side consumers should import `@dbx-tools/genie-shared`
+ * directly: the chat driver pulls in `WorkspaceClient` and is
+ * Node-only, whereas the re-exported protocol surface is pure
+ * (types + sync functions) and safe for any runtime.
  */
 export * from "./src/chat.js";
 export * from "@dbx-tools/genie-shared";

package/dist/index.js

@@ -1,33 +1,15 @@
 /**
  * `@dbx-tools/genie` public surface.
  *
- *   - {@link genieChat}: low-level async generator. Yields every
- *     poll-observed `GenieMessage` for a single turn against a
- *     Genie space. Multi-turn conversations are driven by the
- *     caller (thread the `conversation_id` off each yielded
- *     message into the next call's `options.conversationId`).
- *   - {@link genieEventChat}: high-level async generator. Drives
- *     `genieChat` and yields a strongly-typed
- *     {@link GenieChatEvent} stream of flat `{type, ...fields}`
- *     records (`message`, `status`, `attachment`, `thinking`,
- *     `text`, `query`, `statement`, `rows`,
- *     `suggested_questions`, `result`). The final yield for any
- *     terminal turn is always `{ type: "result", ... }`.
+ * Bundles the package's Node-side chat driver with a re-export of
+ * the pure `@dbx-tools/genie-shared` wire vocabulary so a single
+ * `from "@dbx-tools/genie"` import serves server-side consumers
+ * that need both the live driver and the protocol types.
  *
- * Wire-format types, the {@link GenieChatEvent} discriminated
- * union, per-event detectors (`detectStatus`, `detectThinking`,
- * `detectAttachmentAdded`, `detectText`, `detectQuery`,
- * `detectStatement`, `detectRows`, `detectSuggestedQuestions`),
- * the `eventsFromMessage` sync generator, and terminal-status
- * helpers all live in `@dbx-tools/genie-shared` and are
- * re-exported here so a single `from "@dbx-tools/genie"` import
- * works for server-side consumers. Browser-side consumers should
- * import from `@dbx-tools/genie-shared` directly to avoid pulling
- * in the Node-only `chat.ts` runtime.
- *
- * Browser safety: `chat.ts` pulls in `WorkspaceClient` and is
- * Node-only; the re-exports from `@dbx-tools/genie-shared` are
- * pure (types + sync functions) and safe for any runtime.
+ * Browser-side consumers should import `@dbx-tools/genie-shared`
+ * directly: the chat driver pulls in `WorkspaceClient` and is
+ * Node-only, whereas the re-exported protocol surface is pure
+ * (types + sync functions) and safe for any runtime.
  */
 export * from "./src/chat.js";
 export * from "@dbx-tools/genie-shared";

package/dist/src/chat.d.ts

@@ -1,28 +1,24 @@
 /**
  * `@dbx-tools/genie` chat driver.
  *
- * Two async generators ship from this file. Both take a single
- * `content` string for one turn against a Genie space; for
- * multi-turn conversations, the caller drives the loop and
- * threads the `conversation_id` returned on each
- * `GenieMessage` into the next call's `options.conversationId`.
+ * Drives a single turn against a Genie space from one `content`
+ * string; multi-turn conversations are the caller's job (thread
+ * the `conversation_id` returned on each `GenieMessage` back into
+ * the next turn's `options.conversationId`).
  *
- *   - {@link genieChat}: low-level. Yields every poll-observed
- *     `GenieMessage` verbatim. Cancellation, conversation seeding,
- *     distinct-filtering, and SDK quirks (Waiter stripping) live
- *     here. Use directly when you want the raw stream.
- *   - {@link genieEventChat}: high-level. Wraps `genieChat` and
- *     emits semantic, deduplicated events as a typed
- *     `{ type, payload }` stream (see {@link GenieChatEvent}). The
- *     final yield for a successful turn is always
- *     `{ type: "result", payload }` carrying the terminal
- *     `GenieMessage`. Errors propagate by the generator throwing -
- *     there is no `"error"` variant.
- *
- * Pick the layer that matches your consumer. Iterating UI / agent
- * code that wants every message verbatim should use `genieChat`.
- * Subscribers that want to react to "Genie is thinking about X"
- * or "Genie produced text Y" should use `genieEventChat`.
+ * Two layers serve two kinds of consumer. The low-level layer
+ * yields every poll-observed `GenieMessage` verbatim and owns the
+ * messy parts - cancellation, conversation seeding,
+ * distinct-filtering, and SDK quirks (Waiter stripping); reach for
+ * it when you want the raw stream. The high-level layer wraps it
+ * and emits semantic, deduplicated `{ type, payload }` events
+ * (see {@link GenieChatEvent}), always closing a successful turn
+ * with a terminal `result` event carrying the final
+ * `GenieMessage`; errors propagate by throwing, with no `error`
+ * variant. Iterating UI / agent code that wants every message
+ * verbatim takes the low-level stream; subscribers reacting to
+ * "Genie is thinking about X" or "Genie produced text Y" take the
+ * event layer.
  */
 import { WorkspaceClient } from "@databricks/sdk-experimental";
 import { type GenieChatEvent, type GenieMessage } from "@dbx-tools/genie-shared";

package/dist/src/chat.js

@@ -1,28 +1,24 @@
 /**
  * `@dbx-tools/genie` chat driver.
  *
- * Two async generators ship from this file. Both take a single
- * `content` string for one turn against a Genie space; for
- * multi-turn conversations, the caller drives the loop and
- * threads the `conversation_id` returned on each
- * `GenieMessage` into the next call's `options.conversationId`.
+ * Drives a single turn against a Genie space from one `content`
+ * string; multi-turn conversations are the caller's job (thread
+ * the `conversation_id` returned on each `GenieMessage` back into
+ * the next turn's `options.conversationId`).
  *
- *   - {@link genieChat}: low-level. Yields every poll-observed
- *     `GenieMessage` verbatim. Cancellation, conversation seeding,
- *     distinct-filtering, and SDK quirks (Waiter stripping) live
- *     here. Use directly when you want the raw stream.
- *   - {@link genieEventChat}: high-level. Wraps `genieChat` and
- *     emits semantic, deduplicated events as a typed
- *     `{ type, payload }` stream (see {@link GenieChatEvent}). The
- *     final yield for a successful turn is always
- *     `{ type: "result", payload }` carrying the terminal
- *     `GenieMessage`. Errors propagate by the generator throwing -
- *     there is no `"error"` variant.
- *
- * Pick the layer that matches your consumer. Iterating UI / agent
- * code that wants every message verbatim should use `genieChat`.
- * Subscribers that want to react to "Genie is thinking about X"
- * or "Genie produced text Y" should use `genieEventChat`.
+ * Two layers serve two kinds of consumer. The low-level layer
+ * yields every poll-observed `GenieMessage` verbatim and owns the
+ * messy parts - cancellation, conversation seeding,
+ * distinct-filtering, and SDK quirks (Waiter stripping); reach for
+ * it when you want the raw stream. The high-level layer wraps it
+ * and emits semantic, deduplicated `{ type, payload }` events
+ * (see {@link GenieChatEvent}), always closing a successful turn
+ * with a terminal `result` event carrying the final
+ * `GenieMessage`; errors propagate by throwing, with no `error`
+ * variant. Iterating UI / agent code that wants every message
+ * verbatim takes the low-level stream; subscribers reacting to
+ * "Genie is thinking about X" or "Genie produced text Y" take the
+ * event layer.
  */
 import { WorkspaceClient } from "@databricks/sdk-experimental";
 import { eventsFromMessage, isTerminalStatus, } from "@dbx-tools/genie-shared";