@luzmo/analytics-components-kit 1.0.8-beta.4 → 1.0.8-beta.6

package/custom-elements.json

@@ -131,6 +131,24 @@
             }
           ]
         },
+        {
+          "kind": "function",
+          "name": "buildCustomItemAiPromptProperties",
+          "return": {
+            "type": {
+              "text": "AiPromptProperties"
+            }
+          },
+          "parameters": [
+            {
+              "name": "ctx",
+              "type": {
+                "text": "BuildAiPromptRequestContext"
+              }
+            }
+          ],
+          "description": "Properties for the custom-item agent, which authors custom chart code. It reads no datasets\nand replies in markdown, which the chat renders."
+        },
         {
           "kind": "function",
           "name": "buildSavedAgentAiPromptProperties",
@@ -467,6 +485,14 @@
             "module": "src/components/ai-chat/ai-chat-request.ts"
           }
         },
+        {
+          "kind": "js",
+          "name": "buildCustomItemAiPromptProperties",
+          "declaration": {
+            "name": "buildCustomItemAiPromptProperties",
+            "module": "src/components/ai-chat/ai-chat-request.ts"
+          }
+        },
         {
           "kind": "js",
           "name": "buildSavedAgentAiPromptProperties",
@@ -693,6 +719,17 @@
               "description": "When true, hides the dataset row and add-dataset button entirely",
               "attribute": "hide-selected-datasets"
             },
+            {
+              "kind": "field",
+              "name": "hideAgents",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "When true, hides the Agents section in the input and runs prompts without a picked agent",
+              "attribute": "hide-agents",
+              "reflects": true
+            },
             {
               "kind": "field",
               "name": "disableColumnMentions",
@@ -760,9 +797,17 @@
                 "text": "AiPromptAgent"
               },
               "default": "'item'",
-              "description": "Which aiprompt agent to use. Determines request payload and stream handling.\nWith `agent-id` set it no longer shapes the request payload, only stream handling.",
+              "description": "Which aiprompt agent to use (`item`, `dashboard`, `analyst` or `custom-item`). Determines request\npayload and stream handling. With `agent-id` set it no longer shapes the request payload, only stream handling.\nCustom-item hosts must set `hide-agents` and leave `agent-id` unset to preserve draft context\nand internal repair prompts.",
               "attribute": "agent"
             },
+            {
+              "kind": "field",
+              "name": "agentConfig",
+              "type": {
+                "text": "AiChatAgentConfig | undefined"
+              },
+              "description": "Typed agent selection and context. Takes precedence over legacy agent, task and context properties.\nOmit context to preserve the same agent's session context; use null to clear it.\nUndefined leaves a host session's typed configuration intact and uses legacy properties for an internal session."
+            },
             {
               "kind": "field",
               "name": "agentId",
@@ -831,6 +876,15 @@
               "description": "Dashboard context for `agent=\"dashboard\"`.",
               "attribute": "dashboard"
             },
+            {
+              "kind": "field",
+              "name": "customItem",
+              "type": {
+                "text": "AiPromptCustomItemInput['value'] | null"
+              },
+              "default": "null",
+              "description": "Draft context for `agent=\"custom-item\"`, sent as its `custom-item` input. The host owns the\nshape: the chart document under `document`, plus fields such as `chartId`.\nWith a host `chatSession`, the default null preserves its draft. Once this element supplies\na draft, setting this property to null clears the session's custom item context."
+            },
             {
               "kind": "field",
               "name": "currentScreenMode",
@@ -1383,14 +1437,14 @@
               "type": {
                 "text": "CustomEvent<AiChatStepEvent>"
               },
-              "description": "Fired for every incremental, kit-assembled event during a streamed response (decision, text, progress, dashboard-title/layout/item, chart, interrupt, plus forward-by-default unrecognized chunks). Use `isRecognizedStep` to narrow."
+              "description": "Fired for every incremental, kit-assembled event during a streamed response (decision, text, progress, dashboard-title/layout/item, chart, custom-item, elicitation, interrupt, plus forward-by-default unrecognized chunks). Use `isRecognizedStep` to narrow."
             },
             {
               "name": "luzmo-complete",
               "type": {
                 "text": "CustomEvent<AiChatCompleteEvent>"
               },
-              "description": "Fired exactly once per response with the authoritative final result (dashboard/chart/name) or an `error`."
+              "description": "Fired exactly once per response with the authoritative final result (dashboard/chart/name/customItem) or an `error`."
             },
             {
               "name": "luzmo-stop",
@@ -1559,6 +1613,15 @@
               "description": "When true, hides the dataset row and add-dataset button entirely",
               "fieldName": "hideSelectedDatasets"
             },
+            {
+              "name": "hide-agents",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "When true, hides the Agents section in the input and runs prompts without a picked agent",
+              "fieldName": "hideAgents"
+            },
             {
               "name": "disable-column-mentions",
               "type": {
@@ -1610,7 +1673,7 @@
                 "text": "AiPromptAgent"
               },
               "default": "'item'",
-              "description": "Which aiprompt agent to use. Determines request payload and stream handling.\nWith `agent-id` set it no longer shapes the request payload, only stream handling.",
+              "description": "Which aiprompt agent to use (`item`, `dashboard`, `analyst` or `custom-item`). Determines request\npayload and stream handling. With `agent-id` set it no longer shapes the request payload, only stream handling.\nCustom-item hosts must set `hide-agents` and leave `agent-id` unset to preserve draft context\nand internal repair prompts.",
               "fieldName": "agent"
             },
             {
@@ -1781,6 +1844,12 @@
       "declarations": [],
       "exports": []
     },
+    {
+      "kind": "javascript-module",
+      "path": "src/components/ai-chat/types.ts",
+      "declarations": [],
+      "exports": []
+    },
     {
       "kind": "javascript-module",
       "path": "src/components/ai-chat/empty-state/ai-chat-empty-state.ts",
@@ -2081,6 +2150,133 @@
       "declarations": [],
       "exports": []
     },
+    {
+      "kind": "javascript-module",
+      "path": "src/components/ai-chat/helpers/agent-config.ts",
+      "declarations": [
+        {
+          "kind": "function",
+          "name": "resolveAiChatAgentConfig",
+          "return": {
+            "type": {
+              "text": "AiChatAgentConfig"
+            }
+          },
+          "parameters": [
+            {
+              "name": "source",
+              "type": {
+                "text": "AgentConfigSource"
+              }
+            },
+            {
+              "name": "previous",
+              "optional": true,
+              "type": {
+                "text": "AiChatAgentConfig"
+              }
+            }
+          ],
+          "description": "Adapt existing flat inputs, or inherit omitted typed context only when the agent type matches."
+        },
+        {
+          "kind": "function",
+          "name": "agentRequestContext",
+          "return": {
+            "type": {
+              "text": "LegacyAgentContext"
+            }
+          },
+          "parameters": [
+            {
+              "name": "config",
+              "type": {
+                "text": "AiChatAgentConfig"
+              }
+            }
+          ],
+          "description": "Clear inactive legacy fields so a typed configuration cannot leak another agent's context."
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "resolveAiChatAgentConfig",
+          "declaration": {
+            "name": "resolveAiChatAgentConfig",
+            "module": "src/components/ai-chat/helpers/agent-config.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "agentRequestContext",
+          "declaration": {
+            "name": "agentRequestContext",
+            "module": "src/components/ai-chat/helpers/agent-config.ts"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/components/ai-chat/helpers/elicitation-template.ts",
+      "declarations": [
+        {
+          "kind": "function",
+          "name": "readElicitationAnswer",
+          "return": {
+            "type": {
+              "text": "string | undefined"
+            }
+          },
+          "parameters": [
+            {
+              "name": "detail",
+              "type": {
+                "text": "QuestionBoxResultDetail"
+              }
+            }
+          ],
+          "description": "Reads the chosen option from a question box `luzmo-submit` event."
+        },
+        {
+          "kind": "function",
+          "name": "elicitationMarkup",
+          "return": {
+            "type": {
+              "text": "unknown"
+            }
+          },
+          "parameters": [
+            {
+              "name": "{ message, state, onSubmit }",
+              "type": {
+                "text": "ElicitationMarkupArgs"
+              }
+            }
+          ],
+          "description": "Renders the agent question on an assistant message as a single-choice question box."
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "readElicitationAnswer",
+          "declaration": {
+            "name": "readElicitationAnswer",
+            "module": "src/components/ai-chat/helpers/elicitation-template.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "elicitationMarkup",
+          "declaration": {
+            "name": "elicitationMarkup",
+            "module": "src/components/ai-chat/helpers/elicitation-template.ts"
+          }
+        }
+      ]
+    },
     {
       "kind": "javascript-module",
       "path": "src/components/ai-chat/session/ai-chat-session-controller.ts",
@@ -2256,6 +2452,15 @@
               },
               "readonly": true
             },
+            {
+              "kind": "field",
+              "name": "agentConfig",
+              "type": {
+                "text": "AiChatAgentConfig"
+              },
+              "description": "Effective built-in agent and context after applying typed configuration or legacy compatibility inputs.",
+              "readonly": true
+            },
             {
               "kind": "method",
               "name": "subscribe",
@@ -2423,6 +2628,13 @@
                   "type": {
                     "text": "string | undefined"
                   }
+                },
+                {
+                  "name": "options",
+                  "default": "{}",
+                  "type": {
+                    "text": "{ internal?: boolean }"
+                  }
                 }
               ]
             },
@@ -2438,7 +2650,7 @@
                 {
                   "name": "params",
                   "type": {
-                    "text": "{\n    prompt: string;\n    selectedDatasets: Dataset[];\n    datasetIds: string[];\n    signal?: AbortSignal;\n    attachments?: PromptBoxAttachment[];\n    attachmentUrls?: string[];\n    agentId?: string;\n  }"
+                    "text": "{\n    prompt: string;\n    selectedDatasets: Dataset[];\n    datasetIds: string[];\n    signal?: AbortSignal;\n    attachments?: PromptBoxAttachment[];\n    attachmentUrls?: string[];\n    agentId?: string;\n    internal?: boolean;\n  }"
                   }
                 }
               ],
@@ -2462,6 +2674,37 @@
               ],
               "description": "Append the user prompt (unless `skipUserMessage`), start streaming, and update state."
             },
+            {
+              "kind": "method",
+              "name": "answerElicitation",
+              "return": {
+                "type": {
+                  "text": "Promise<boolean>"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "messageId",
+                  "type": {
+                    "text": "string"
+                  }
+                },
+                {
+                  "name": "answer",
+                  "type": {
+                    "text": "string"
+                  }
+                },
+                {
+                  "name": "params",
+                  "default": "{}",
+                  "type": {
+                    "text": "Omit<AiChatSessionSubmitParams, 'prompt'>"
+                  }
+                }
+              ],
+              "description": "Answer the clarifying question on the last message and send the answer as the next prompt.\nResolves to `false` without sending while a response is generating, when that message has no open\nquestion or another message follows it, when `answer` is not one of its options, when the dataset requirement is not met, or when\nthe send is aborted or superseded before the request goes out; the answer is cleared again then."
+            },
             {
               "kind": "method",
               "name": "restore",
@@ -2734,6 +2977,24 @@
             }
           ],
           "description": "Collect dashboard name from whichever asset array the chunk exposes."
+        },
+        {
+          "kind": "function",
+          "name": "extractCustomItemFromChunk",
+          "return": {
+            "type": {
+              "text": "AiPromptCustomItemInput['value'] | null"
+            }
+          },
+          "parameters": [
+            {
+              "name": "chunk",
+              "type": {
+                "text": "Record<string, unknown>"
+              }
+            }
+          ],
+          "description": "Reads custom-item drafts from top-level or terminal assistant-message assets."
         }
       ],
       "exports": [
@@ -2808,6 +3069,14 @@
             "name": "extractDashboardNameFromChunk",
             "module": "src/components/ai-chat/stream/chunk-extractors.ts"
           }
+        },
+        {
+          "kind": "js",
+          "name": "extractCustomItemFromChunk",
+          "declaration": {
+            "name": "extractCustomItemFromChunk",
+            "module": "src/components/ai-chat/stream/chunk-extractors.ts"
+          }
         }
       ]
     },
@@ -3242,6 +3511,17 @@
               "default": "null",
               "description": "The saved Agent the prompt is scoped to, or null"
             },
+            {
+              "kind": "field",
+              "name": "hideAgents",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "When true, hides the Agents section in the add dropdown and ignores `selectedAgent` for `require-dataset` and `prompt-submitted`",
+              "attribute": "hide-agents",
+              "reflects": true
+            },
             {
               "kind": "field",
               "name": "disableDatasetModification",
@@ -3532,6 +3812,14 @@
               "name": "hide-selected-datasets",
               "kind": "field"
             },
+            {
+              "type": {
+                "text": "boolean"
+              },
+              "description": "When true, hides the Agents section in the add dropdown and ignores `selectedAgent` for `require-dataset` and `prompt-submitted`",
+              "name": "hide-agents",
+              "kind": "field"
+            },
             {
               "type": {
                 "text": "boolean"
@@ -3739,6 +4027,15 @@
               "description": "Maximum number of selected dataset tags shown before the overflow control.",
               "fieldName": "maxVisibleSelectedDatasets"
             },
+            {
+              "name": "hide-agents",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "When true, hides the Agents section in the add dropdown and ignores `selectedAgent` for `require-dataset` and `prompt-submitted`",
+              "fieldName": "hideAgents"
+            },
             {
               "name": "disable-dataset-modification",
               "type": {
@@ -5937,6 +6234,17 @@
               "default": "null",
               "description": "The agent the chat is scoped to, or null"
             },
+            {
+              "kind": "field",
+              "name": "hideAgents",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "When true, hides the Agents section and ignores `selectedAgent`",
+              "attribute": "hide-agents",
+              "reflects": true
+            },
             {
               "kind": "field",
               "name": "buttonLabel",
@@ -6073,6 +6381,14 @@
               "name": "max-visible-selected-datasets",
               "kind": "field"
             },
+            {
+              "type": {
+                "text": "boolean"
+              },
+              "description": "When true, hides the Agents section and ignores `selectedAgent`",
+              "name": "hide-agents",
+              "kind": "field"
+            },
             {
               "type": {
                 "text": "string"
@@ -6170,6 +6486,15 @@
               "description": "Array of selected datasets",
               "fieldName": "selectedDatasets"
             },
+            {
+              "name": "hide-agents",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "When true, hides the Agents section and ignores `selectedAgent`",
+              "fieldName": "hideAgents"
+            },
             {
               "name": "button-label",
               "type": {
@@ -6274,7 +6599,7 @@
           },
           "tagName": "luzmo-dataset-selector-row",
           "customElement": true,
-          "summary": "A row component for selecting and managing datasets with pills and overlay. The dropdown lists up to five saved Agents in a labelled section above the datasets, so a chat can be scoped to an agent from the same control. Theme Lucero primitives (`luzmo-select`, options, popover, tags) with `--luzmo-select-*`, `--luzmo-popover-max-height`, `--luzmo-option-*`, `--luzmo-tag-*` on this host or an ancestor; optional `--luzmo-dataset-selector-row-*` overrides ACK row shell defaults (gap, typography, search max width, scoped popover height)."
+          "summary": "A row component for selecting and managing datasets with pills and overlay. The dropdown lists up to five saved Agents in a labelled section above the datasets, so a chat can be scoped to an agent from the same control; `hide-agents` turns that section off. Theme Lucero primitives (`luzmo-select`, options, popover, tags) with `--luzmo-select-*`, `--luzmo-popover-max-height`, `--luzmo-option-*`, `--luzmo-tag-*` on this host or an ancestor; optional `--luzmo-dataset-selector-row-*` overrides ACK row shell defaults (gap, typography, search max width, scoped popover height)."
         }
       ],
       "exports": [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@luzmo/analytics-components-kit",
-  "version": "1.0.8-beta.4",
+  "version": "1.0.8-beta.6",
   "type": "module",
   "main": "./components/index.js",
   "module": "./components/index.js",
@@ -349,9 +349,9 @@
     "@codemirror/commands": "^6.10.3",
     "@codemirror/state": "^6.6.0",
     "@codemirror/view": "^6.43.1",
-    "@luzmo/dashboard-contents-types": "1.0.42",
+    "@luzmo/dashboard-contents-types": "1.0.43",
     "@tanstack/query-core": "^5.90.5",
-    "dompurify": "^3.4.12",
+    "dompurify": "^3.4.16",
     "gridstack": "^12.3.3",
     "marked": "^18.0.5",
     "uuid": "^14.0.0"

package/react/components/ai-chat.component.ts

@@ -22,8 +22,8 @@ const LuzmoAiChatComponent = createComponent({
  *
  * @event onLuzmoMessageSent - Fired when a user sends a message
  * @event onLuzmoDatasetsChanged - Fired when the selected datasets change
- * @event onLuzmoStep - Fired for every incremental, kit-assembled event during a streamed response (decision, text, progress, dashboard-title/layout/item, chart, interrupt, plus forward-by-default unrecognized chunks). Use `isRecognizedStep` to narrow.
- * @event onLuzmoComplete - Fired exactly once per response with the authoritative final result (dashboard/chart/name) or an `error`.
+ * @event onLuzmoStep - Fired for every incremental, kit-assembled event during a streamed response (decision, text, progress, dashboard-title/layout/item, chart, custom-item, elicitation, interrupt, plus forward-by-default unrecognized chunks). Use `isRecognizedStep` to narrow.
+ * @event onLuzmoComplete - Fired exactly once per response with the authoritative final result (dashboard/chart/name/customItem) or an `error`.
  * @event onLuzmoStop - Fired when an in-flight prompt is stopped Custom actions beyond built-in `ChatMessage.actions` buttons can be projected via the `assistant-message-actions` light-DOM slot on the latest assistant message.
  * @event onLuzmoConversationIdChanged - Fired when the conversation ID is updated from the API
  * @event onLuzmoAssistantMessageAction - Fired when a built-in assistant message action is activated (after confirmation when `confirm` is set)

package/react/esm/components/ai-chat.component.d.ts

@@ -5,8 +5,8 @@ import { LuzmoAiChat as LuzmoAiChatClass, AiChatCompleteEvent, AiChatConversatio
  *
  * @event onLuzmoMessageSent - Fired when a user sends a message
  * @event onLuzmoDatasetsChanged - Fired when the selected datasets change
- * @event onLuzmoStep - Fired for every incremental, kit-assembled event during a streamed response (decision, text, progress, dashboard-title/layout/item, chart, interrupt, plus forward-by-default unrecognized chunks). Use `isRecognizedStep` to narrow.
- * @event onLuzmoComplete - Fired exactly once per response with the authoritative final result (dashboard/chart/name) or an `error`.
+ * @event onLuzmoStep - Fired for every incremental, kit-assembled event during a streamed response (decision, text, progress, dashboard-title/layout/item, chart, custom-item, elicitation, interrupt, plus forward-by-default unrecognized chunks). Use `isRecognizedStep` to narrow.
+ * @event onLuzmoComplete - Fired exactly once per response with the authoritative final result (dashboard/chart/name/customItem) or an `error`.
  * @event onLuzmoStop - Fired when an in-flight prompt is stopped Custom actions beyond built-in `ChatMessage.actions` buttons can be projected via the `assistant-message-actions` light-DOM slot on the latest assistant message.
  * @event onLuzmoConversationIdChanged - Fired when the conversation ID is updated from the API
  * @event onLuzmoAssistantMessageAction - Fired when a built-in assistant message action is activated (after confirmation when `confirm` is set)

package/react/esm/components/ai-chat.component.js

@@ -20,8 +20,8 @@ const LuzmoAiChatComponent = createComponent({
  *
  * @event onLuzmoMessageSent - Fired when a user sends a message
  * @event onLuzmoDatasetsChanged - Fired when the selected datasets change
- * @event onLuzmoStep - Fired for every incremental, kit-assembled event during a streamed response (decision, text, progress, dashboard-title/layout/item, chart, interrupt, plus forward-by-default unrecognized chunks). Use `isRecognizedStep` to narrow.
- * @event onLuzmoComplete - Fired exactly once per response with the authoritative final result (dashboard/chart/name) or an `error`.
+ * @event onLuzmoStep - Fired for every incremental, kit-assembled event during a streamed response (decision, text, progress, dashboard-title/layout/item, chart, custom-item, elicitation, interrupt, plus forward-by-default unrecognized chunks). Use `isRecognizedStep` to narrow.
+ * @event onLuzmoComplete - Fired exactly once per response with the authoritative final result (dashboard/chart/name/customItem) or an `error`.
  * @event onLuzmoStop - Fired when an in-flight prompt is stopped Custom actions beyond built-in `ChatMessage.actions` buttons can be projected via the `assistant-message-actions` light-DOM slot on the latest assistant message.
  * @event onLuzmoConversationIdChanged - Fired when the conversation ID is updated from the API
  * @event onLuzmoAssistantMessageAction - Fired when a built-in assistant message action is activated (after confirmation when `confirm` is set)

package/react/package.json

@@ -29,7 +29,7 @@
   "peerDependencies": {
     "@lit/react": "^1.0.6",
     "react": "^18.0.0 || ^19.0.0",
-    "@luzmo/analytics-components-kit": "^1.0.8-beta.4"
+    "@luzmo/analytics-components-kit": "^1.0.8-beta.6"
   },
-  "version": "1.0.8-beta.4"
+  "version": "1.0.8-beta.6"
 }

package/types/ai-chat.types.d.ts

@@ -21,6 +21,13 @@ export interface AssistantMessageAction {
     /** Confirm button variant. Used when `confirm` is true; defaults to `negative`. */
     confirmVariant?: AssistantMessageActionConfirmVariant;
 }
+/** A clarifying question an agent asked, answered by choosing one of its options. */
+export interface ChatMessageElicitation {
+    question: string;
+    options: string[];
+    /** The chosen option, once answered. */
+    answer?: string;
+}
 export interface ChatMessage {
     id?: string;
     apiMessageId?: string;
@@ -37,6 +44,8 @@ export interface ChatMessage {
     attachmentUrls?: string[];
     /** Built-in action buttons rendered below this assistant message. Use slots for custom actions. */
     actions?: AssistantMessageAction[];
+    /** Clarifying question on an assistant message, rendered as a question box. */
+    elicitation?: ChatMessageElicitation;
 }
 export interface AssistantMessageActionEventDetail {
     messageId: string;