@lmnr-ai/types 0.8.39 → 0.8.41

package/dist/index.d.cts

@@ -265,25 +265,19 @@ interface InitializeOptions {
 //#endregion
 //#region src/session-block.d.ts
 /**
- * Shared contract for debugger-session blocks.
+ * Shared contract for debugger-session blocks — an ordered list of blocks (see
+ * app-server `debugger_session_blocks`), each with a `type` and type-specific
+ * `content`:
  *
- * A debug session renders as an ordered list of blocks (see the app-server
- * `debugger_session_blocks` table). Each block has a plain-text `type` and a
- * jsonb `content` whose shape depends on the type:
+ *  - `trace`      — a trace under the session; written at ingest.
+ *  - `evaluation` — an eval under the session; written at eval creation.
+ *  - `text`       — a free-text note via `debug session add-note`.
+ *  - `command`    — a CLI command (`sql query`, `ask`) recorded into the session.
  *
- *  - `trace`      — a trace produced under the session (`rollout.session_id`);
- *    written at ingest.
- *  - `evaluation` — an evaluation created under the session; written at eval
- *    creation.
- *  - `text`       — a free-text note the agent attaches post-factum via
- *    `lmnr-cli debug session add-note` (keyed by session id, not tied to any
- *    trace / eval).
- *
- * `type` is a plain string on the wire so new block types can be added without
- * a client bump; the union below is the set this SDK knows how to render.
+ * `type` is a plain string on the wire so new types need no client bump.
  */
 /** Block type the CLI knows how to render. `type` is a plain string on the wire. */
-type SessionBlockType = "trace" | "evaluation" | "text";
+type SessionBlockType = "trace" | "evaluation" | "text" | "command";
 /** `content` of a `trace` block. */
 interface TraceBlockContent {
   traceId: string;
@@ -300,15 +294,27 @@ interface EvaluationBlockContent {
 interface TextBlockContent {
   text: string;
 }
+/** `content` of a `command` block — a CLI command recorded into the session. */
+interface CommandBlockContent {
+  /** The command path, e.g. `"sql query"` or `"ask"`. */
+  command: string;
+  /** The command's positional arguments (raw — may contain the query text). */
+  args: string[];
+  /** The process exit code observed at post-action time (0 on the success path). */
+  exitCode: number;
+  /** Captured stdout, truncated to a bounded prefix. Null when empty. */
+  output?: string | null;
+  /** Captured stderr, truncated to a bounded prefix. Null when empty. */
+  stderr?: string | null;
+  /** Agent reasoning for this step, via `--reasoning`. Null when not provided. */
+  reasoning?: string | null;
+}
 /** Union of the known block content shapes. */
-type SessionBlockContent = TraceBlockContent | EvaluationBlockContent | TextBlockContent;
+type SessionBlockContent = TraceBlockContent | EvaluationBlockContent | TextBlockContent | CommandBlockContent;
 /**
- * One block in a debugger session, as returned by
- * `GET /v1/cli/rollouts/{sessionId}/blocks`.
- *
- * `content` is typed loosely (`Record<string, unknown>`) because `type` is
- * open-ended on the wire; narrow it with the `*BlockContent` interfaces above
- * once `type` is known.
+ * One block in a debugger session (from `GET /v1/cli/rollouts/{sessionId}/blocks`).
+ * `content` is loose (`Record<string, unknown>`) since `type` is open-ended;
+ * narrow it with the `*BlockContent` interfaces above once `type` is known.
  */
 interface SessionBlock {
   /** Block id (deterministic UUIDv5 for trace/eval blocks; random for text). */
@@ -321,6 +327,45 @@ interface SessionBlock {
   content: Record<string, unknown>;
 }
 //#endregion
+//#region src/sql-schema.d.ts
+/**
+ * Shared contract for `GET /v1/sql/schema` (and its `/v1/cli` twin) — the
+ * logical tables, columns, and enums the SQL engine exposes.
+ *
+ * The server serializes this straight from app-server's
+ * `query_engine::schema` consts, which also render the MCP `query_laminar_sql`
+ * tool description and the Platform Agent prompt. That is the point: the CLI
+ * used to carry a hand-maintained copy, and it drifted badly enough to
+ * advertise columns that did not exist. Do NOT reintroduce a local copy —
+ * `lmnr-cli sql schema` renders whatever the server returns.
+ */
+/** One column of a queryable table. `type` is the ClickHouse type as a string. */
+interface SqlSchemaColumn {
+  name: string;
+  /** ClickHouse type, e.g. `UUID`, `DateTime64(9,'UTC')`, `String (enum status)`. */
+  type: string;
+  description: string;
+}
+/**
+ * One logical table. The caller writes this name; the engine rewrites it to a
+ * project-scoped view.
+ */
+interface SqlSchemaTable {
+  name: string;
+  description: string;
+  columns: SqlSchemaColumn[];
+}
+/** A constrained column and the literals it accepts. */
+interface SqlSchemaEnum {
+  name: string;
+  values: string[];
+}
+/** Full response body of the schema endpoint. */
+interface SqlSchema {
+  tables: SqlSchemaTable[];
+  enums: SqlSchemaEnum[];
+}
+//#endregion
 //#region src/tracing.d.ts
 /**
  * Span types to categorize spans.
@@ -399,5 +444,5 @@ type Event = {
   value: number | string | null;
 };
 //#endregion
-export { CachedSpan, DEBUG_SESSION_DIR, DEBUG_SESSION_FILE, Datapoint, Dataset, DebugContext, DebugSessionFile, EvaluationBlockContent, EvaluationDatapoint, EvaluationDatapointDatasetLink, Event, GetDatapointsResponse, InitEvaluationResponse, InitializeOptions, LaminarSpanContext, MaskInputOptions, PushDatapointsResponse, SemanticSearchResponse, SemanticSearchResult, SessionBlock, SessionBlockContent, SessionBlockType, SessionRecordingOptions, SpanExporter, SpanProcessor, SpanType, StringUUID, TextBlockContent, TraceBlockContent, TraceType, TracingLevel, errorMessage };
+export { CachedSpan, CommandBlockContent, DEBUG_SESSION_DIR, DEBUG_SESSION_FILE, Datapoint, Dataset, DebugContext, DebugSessionFile, EvaluationBlockContent, EvaluationDatapoint, EvaluationDatapointDatasetLink, Event, GetDatapointsResponse, InitEvaluationResponse, InitializeOptions, LaminarSpanContext, MaskInputOptions, PushDatapointsResponse, SemanticSearchResponse, SemanticSearchResult, SessionBlock, SessionBlockContent, SessionBlockType, SessionRecordingOptions, SpanExporter, SpanProcessor, SpanType, SqlSchema, SqlSchemaColumn, SqlSchemaEnum, SqlSchemaTable, StringUUID, TextBlockContent, TraceBlockContent, TraceType, TracingLevel, errorMessage };
 //# sourceMappingURL=index.d.cts.map

package/dist/index.d.mts

@@ -265,25 +265,19 @@ interface InitializeOptions {
 //#endregion
 //#region src/session-block.d.ts
 /**
- * Shared contract for debugger-session blocks.
+ * Shared contract for debugger-session blocks — an ordered list of blocks (see
+ * app-server `debugger_session_blocks`), each with a `type` and type-specific
+ * `content`:
  *
- * A debug session renders as an ordered list of blocks (see the app-server
- * `debugger_session_blocks` table). Each block has a plain-text `type` and a
- * jsonb `content` whose shape depends on the type:
+ *  - `trace`      — a trace under the session; written at ingest.
+ *  - `evaluation` — an eval under the session; written at eval creation.
+ *  - `text`       — a free-text note via `debug session add-note`.
+ *  - `command`    — a CLI command (`sql query`, `ask`) recorded into the session.
  *
- *  - `trace`      — a trace produced under the session (`rollout.session_id`);
- *    written at ingest.
- *  - `evaluation` — an evaluation created under the session; written at eval
- *    creation.
- *  - `text`       — a free-text note the agent attaches post-factum via
- *    `lmnr-cli debug session add-note` (keyed by session id, not tied to any
- *    trace / eval).
- *
- * `type` is a plain string on the wire so new block types can be added without
- * a client bump; the union below is the set this SDK knows how to render.
+ * `type` is a plain string on the wire so new types need no client bump.
  */
 /** Block type the CLI knows how to render. `type` is a plain string on the wire. */
-type SessionBlockType = "trace" | "evaluation" | "text";
+type SessionBlockType = "trace" | "evaluation" | "text" | "command";
 /** `content` of a `trace` block. */
 interface TraceBlockContent {
   traceId: string;
@@ -300,15 +294,27 @@ interface EvaluationBlockContent {
 interface TextBlockContent {
   text: string;
 }
+/** `content` of a `command` block — a CLI command recorded into the session. */
+interface CommandBlockContent {
+  /** The command path, e.g. `"sql query"` or `"ask"`. */
+  command: string;
+  /** The command's positional arguments (raw — may contain the query text). */
+  args: string[];
+  /** The process exit code observed at post-action time (0 on the success path). */
+  exitCode: number;
+  /** Captured stdout, truncated to a bounded prefix. Null when empty. */
+  output?: string | null;
+  /** Captured stderr, truncated to a bounded prefix. Null when empty. */
+  stderr?: string | null;
+  /** Agent reasoning for this step, via `--reasoning`. Null when not provided. */
+  reasoning?: string | null;
+}
 /** Union of the known block content shapes. */
-type SessionBlockContent = TraceBlockContent | EvaluationBlockContent | TextBlockContent;
+type SessionBlockContent = TraceBlockContent | EvaluationBlockContent | TextBlockContent | CommandBlockContent;
 /**
- * One block in a debugger session, as returned by
- * `GET /v1/cli/rollouts/{sessionId}/blocks`.
- *
- * `content` is typed loosely (`Record<string, unknown>`) because `type` is
- * open-ended on the wire; narrow it with the `*BlockContent` interfaces above
- * once `type` is known.
+ * One block in a debugger session (from `GET /v1/cli/rollouts/{sessionId}/blocks`).
+ * `content` is loose (`Record<string, unknown>`) since `type` is open-ended;
+ * narrow it with the `*BlockContent` interfaces above once `type` is known.
  */
 interface SessionBlock {
   /** Block id (deterministic UUIDv5 for trace/eval blocks; random for text). */
@@ -321,6 +327,45 @@ interface SessionBlock {
   content: Record<string, unknown>;
 }
 //#endregion
+//#region src/sql-schema.d.ts
+/**
+ * Shared contract for `GET /v1/sql/schema` (and its `/v1/cli` twin) — the
+ * logical tables, columns, and enums the SQL engine exposes.
+ *
+ * The server serializes this straight from app-server's
+ * `query_engine::schema` consts, which also render the MCP `query_laminar_sql`
+ * tool description and the Platform Agent prompt. That is the point: the CLI
+ * used to carry a hand-maintained copy, and it drifted badly enough to
+ * advertise columns that did not exist. Do NOT reintroduce a local copy —
+ * `lmnr-cli sql schema` renders whatever the server returns.
+ */
+/** One column of a queryable table. `type` is the ClickHouse type as a string. */
+interface SqlSchemaColumn {
+  name: string;
+  /** ClickHouse type, e.g. `UUID`, `DateTime64(9,'UTC')`, `String (enum status)`. */
+  type: string;
+  description: string;
+}
+/**
+ * One logical table. The caller writes this name; the engine rewrites it to a
+ * project-scoped view.
+ */
+interface SqlSchemaTable {
+  name: string;
+  description: string;
+  columns: SqlSchemaColumn[];
+}
+/** A constrained column and the literals it accepts. */
+interface SqlSchemaEnum {
+  name: string;
+  values: string[];
+}
+/** Full response body of the schema endpoint. */
+interface SqlSchema {
+  tables: SqlSchemaTable[];
+  enums: SqlSchemaEnum[];
+}
+//#endregion
 //#region src/tracing.d.ts
 /**
  * Span types to categorize spans.
@@ -399,5 +444,5 @@ type Event = {
   value: number | string | null;
 };
 //#endregion
-export { CachedSpan, DEBUG_SESSION_DIR, DEBUG_SESSION_FILE, Datapoint, Dataset, DebugContext, DebugSessionFile, EvaluationBlockContent, EvaluationDatapoint, EvaluationDatapointDatasetLink, Event, GetDatapointsResponse, InitEvaluationResponse, InitializeOptions, LaminarSpanContext, MaskInputOptions, PushDatapointsResponse, SemanticSearchResponse, SemanticSearchResult, SessionBlock, SessionBlockContent, SessionBlockType, SessionRecordingOptions, SpanExporter, SpanProcessor, SpanType, StringUUID, TextBlockContent, TraceBlockContent, TraceType, TracingLevel, errorMessage };
+export { CachedSpan, CommandBlockContent, DEBUG_SESSION_DIR, DEBUG_SESSION_FILE, Datapoint, Dataset, DebugContext, DebugSessionFile, EvaluationBlockContent, EvaluationDatapoint, EvaluationDatapointDatasetLink, Event, GetDatapointsResponse, InitEvaluationResponse, InitializeOptions, LaminarSpanContext, MaskInputOptions, PushDatapointsResponse, SemanticSearchResponse, SemanticSearchResult, SessionBlock, SessionBlockContent, SessionBlockType, SessionRecordingOptions, SpanExporter, SpanProcessor, SpanType, SqlSchema, SqlSchemaColumn, SqlSchemaEnum, SqlSchemaTable, StringUUID, TextBlockContent, TraceBlockContent, TraceType, TracingLevel, errorMessage };
 //# sourceMappingURL=index.d.mts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lmnr-ai/types",
-  "version": "0.8.39",
+  "version": "0.8.41",
   "description": "Shared types for Laminar AI SDK",
   "main": "dist/index.cjs",
   "module": "dist/index.mjs",