@lmnr-ai/types 0.8.40 → 0.8.42

package/dist/index.d.cts

@@ -327,6 +327,97 @@ interface SessionBlock {
   content: Record<string, unknown>;
 }
 //#endregion
+//#region src/signals.d.ts
+/**
+ * A signal's payload schema — the structured output the LLM must return. Every
+ * field is required (the UI drawer marks them all required); enums are a string
+ * field with an `enum` array.
+ */
+interface SignalStructuredOutput {
+  type: "object";
+  properties: Record<string, {
+    type: string;
+    description: string;
+    enum?: string[];
+  }>;
+  required: string[];
+}
+/**
+ * A signal trigger. The two lists mean different things and are NOT
+ * interchangeable:
+ *
+ * - `conditions` — WHEN the signal is evaluated. Decidable from one span batch
+ *   (`root_span_finished`, `span_name`). An EMPTY list never fires.
+ * - `filters` — WHETHER a fired trigger runs. Properties of the whole trace
+ *   (`total_token_count`, `status`, `span_names`). An empty list passes.
+ *
+ * Note `span_name` (condition, this batch only) and `span_names` (filter,
+ * anywhere in the trace) are DIFFERENT columns.
+ */
+interface SignalTrigger {
+  id?: string;
+  conditions: SignalFilter[];
+  filters: SignalFilter[];
+  createdAt?: string;
+  /** 0 = batch, 1 = realtime */
+  mode?: number;
+}
+interface SignalFilter {
+  column: string;
+  operator: string;
+  value: string | number | string[];
+}
+interface Signal {
+  id: string;
+  projectId: string;
+  name: string;
+  prompt: string;
+  structuredOutput: SignalStructuredOutput;
+  sampleRate: number | null;
+  disabled: boolean;
+  createdAt: string;
+  triggers: SignalTrigger[];
+}
+//#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.
@@ -405,5 +496,5 @@ type Event = {
   value: number | string | null;
 };
 //#endregion
-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, 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, Signal, SignalFilter, SignalStructuredOutput, SignalTrigger, SpanExporter, SpanProcessor, SpanType, SqlSchema, SqlSchemaColumn, SqlSchemaEnum, SqlSchemaTable, StringUUID, TextBlockContent, TraceBlockContent, TraceType, TracingLevel, errorMessage };
 //# sourceMappingURL=index.d.cts.map

package/dist/index.d.mts

@@ -327,6 +327,97 @@ interface SessionBlock {
   content: Record<string, unknown>;
 }
 //#endregion
+//#region src/signals.d.ts
+/**
+ * A signal's payload schema — the structured output the LLM must return. Every
+ * field is required (the UI drawer marks them all required); enums are a string
+ * field with an `enum` array.
+ */
+interface SignalStructuredOutput {
+  type: "object";
+  properties: Record<string, {
+    type: string;
+    description: string;
+    enum?: string[];
+  }>;
+  required: string[];
+}
+/**
+ * A signal trigger. The two lists mean different things and are NOT
+ * interchangeable:
+ *
+ * - `conditions` — WHEN the signal is evaluated. Decidable from one span batch
+ *   (`root_span_finished`, `span_name`). An EMPTY list never fires.
+ * - `filters` — WHETHER a fired trigger runs. Properties of the whole trace
+ *   (`total_token_count`, `status`, `span_names`). An empty list passes.
+ *
+ * Note `span_name` (condition, this batch only) and `span_names` (filter,
+ * anywhere in the trace) are DIFFERENT columns.
+ */
+interface SignalTrigger {
+  id?: string;
+  conditions: SignalFilter[];
+  filters: SignalFilter[];
+  createdAt?: string;
+  /** 0 = batch, 1 = realtime */
+  mode?: number;
+}
+interface SignalFilter {
+  column: string;
+  operator: string;
+  value: string | number | string[];
+}
+interface Signal {
+  id: string;
+  projectId: string;
+  name: string;
+  prompt: string;
+  structuredOutput: SignalStructuredOutput;
+  sampleRate: number | null;
+  disabled: boolean;
+  createdAt: string;
+  triggers: SignalTrigger[];
+}
+//#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.
@@ -405,5 +496,5 @@ type Event = {
   value: number | string | null;
 };
 //#endregion
-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, 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, Signal, SignalFilter, SignalStructuredOutput, SignalTrigger, 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.40",
+  "version": "0.8.42",
   "description": "Shared types for Laminar AI SDK",
   "main": "dist/index.cjs",
   "module": "dist/index.mjs",