@luzmo/analytics-components-kit 1.4.0 → 2.0.1

package/custom-elements.json

@@ -638,6 +638,14 @@
         }
       ],
       "exports": [
+        {
+          "kind": "js",
+          "name": "AiChatInteraction",
+          "declaration": {
+            "name": "AiChatInteraction",
+            "module": "./ai-prompt-types"
+          }
+        },
         {
           "kind": "js",
           "name": "AiPromptAgent",
@@ -646,6 +654,14 @@
             "module": "./ai-prompt-types"
           }
         },
+        {
+          "kind": "js",
+          "name": "AiPromptAnswer",
+          "declaration": {
+            "name": "AiPromptAnswer",
+            "module": "./ai-prompt-types"
+          }
+        },
         {
           "kind": "js",
           "name": "AiPromptBuiltInAgentProperties",
@@ -654,6 +670,14 @@
             "module": "./ai-prompt-types"
           }
         },
+        {
+          "kind": "js",
+          "name": "AiPromptClientCapabilities",
+          "declaration": {
+            "name": "AiPromptClientCapabilities",
+            "module": "./ai-prompt-types"
+          }
+        },
         {
           "kind": "js",
           "name": "AiPromptImageInput",
@@ -1225,6 +1249,15 @@
               "description": "AI model preference for item agent chart generation",
               "attribute": "model-preference"
             },
+            {
+              "kind": "field",
+              "name": "interactions",
+              "type": {
+                "text": "AiChatInteraction[] | undefined"
+              },
+              "description": "Boxes the agent may show, declared on every request as `client_capabilities`. Defaults to none.\nPass `['question']` once the aiprompt API accepts `client_capabilities`. Ignored with a host `chatSession`.",
+              "attribute": "interactions"
+            },
             {
               "kind": "field",
               "name": "chatSession",
@@ -1776,7 +1809,7 @@
               "type": {
                 "text": "CustomEvent<AiChatStepEvent>"
               },
-              "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."
+              "description": "Fired for every incremental, kit-assembled event during a streamed response (decision, text, progress, dashboard-title/layout/item, chart, custom-item, elicitation, question, interrupt, plus forward-by-default unrecognized chunks). Use `isRecognizedStep` to narrow."
             },
             {
               "name": "luzmo-complete",
@@ -2061,6 +2094,14 @@
               "description": "AI model preference for item agent chart generation",
               "fieldName": "modelPreference"
             },
+            {
+              "name": "interactions",
+              "type": {
+                "text": "AiChatInteraction[] | undefined"
+              },
+              "description": "Boxes the agent may show, declared on every request as `client_capabilities`. Defaults to none.\nPass `['question']` once the aiprompt API accepts `client_capabilities`. Ignored with a host `chatSession`.",
+              "fieldName": "interactions"
+            },
             {
               "name": "conversation-id",
               "type": {
@@ -2707,6 +2748,191 @@
         }
       ]
     },
+    {
+      "kind": "javascript-module",
+      "path": "src/components/ai-chat/helpers/interaction-assets.ts",
+      "declarations": [
+        {
+          "kind": "function",
+          "name": "readQuestionAsset",
+          "return": {
+            "type": {
+              "text": "ChatMessageQuestion | null"
+            }
+          },
+          "parameters": [
+            {
+              "name": "assetId",
+              "type": {
+                "text": "string"
+              }
+            },
+            {
+              "name": "value",
+              "type": {
+                "text": "unknown"
+              }
+            }
+          ]
+        },
+        {
+          "kind": "function",
+          "name": "chatMessageBoxesFromAssets",
+          "return": {
+            "type": {
+              "text": "Pick<ChatMessage, 'question'>"
+            }
+          },
+          "parameters": [
+            {
+              "name": "assets",
+              "type": {
+                "text": "readonly unknown[]"
+              }
+            }
+          ],
+          "description": "Maps the stored assets of an assistant message (`aiMessageAssets` from the aiprompt API) onto the\n`question` field of a seeded `ChatMessage`. Assets of other types are ignored."
+        },
+        {
+          "kind": "function",
+          "name": "otherTooLongError",
+          "return": {
+            "type": {
+              "text": "string | null"
+            }
+          },
+          "parameters": [
+            {
+              "name": "response",
+              "type": {
+                "text": "ChatQuestionResponse"
+              }
+            }
+          ]
+        },
+        {
+          "kind": "function",
+          "name": "isQuestionResponseValid",
+          "return": {
+            "type": {
+              "text": "boolean"
+            }
+          },
+          "parameters": [
+            {
+              "name": "questions",
+              "type": {
+                "text": "readonly ChatChoiceQuestion[]"
+              }
+            },
+            {
+              "name": "response",
+              "type": {
+                "text": "ChatQuestionResponse"
+              }
+            }
+          ]
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "readQuestionAsset",
+          "declaration": {
+            "name": "readQuestionAsset",
+            "module": "src/components/ai-chat/helpers/interaction-assets.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "chatMessageBoxesFromAssets",
+          "declaration": {
+            "name": "chatMessageBoxesFromAssets",
+            "module": "src/components/ai-chat/helpers/interaction-assets.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "otherTooLongError",
+          "declaration": {
+            "name": "otherTooLongError",
+            "module": "src/components/ai-chat/helpers/interaction-assets.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "isQuestionResponseValid",
+          "declaration": {
+            "name": "isQuestionResponseValid",
+            "module": "src/components/ai-chat/helpers/interaction-assets.ts"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/components/ai-chat/helpers/question-template.ts",
+      "declarations": [
+        {
+          "kind": "function",
+          "name": "readQuestionResponse",
+          "return": {
+            "type": {
+              "text": "ChatQuestionResponse | null"
+            }
+          },
+          "parameters": [
+            {
+              "name": "question",
+              "type": {
+                "text": "ChatMessageQuestion"
+              }
+            },
+            {
+              "name": "detail",
+              "type": {
+                "text": "QuestionBoxResultDetail"
+              }
+            }
+          ]
+        },
+        {
+          "kind": "function",
+          "name": "questionMarkup",
+          "return": {
+            "type": {
+              "text": "unknown"
+            }
+          },
+          "parameters": [
+            {
+              "name": "{ message, state, size, onAnswer }",
+              "type": {
+                "text": "QuestionMarkupArgs"
+              }
+            }
+          ]
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "readQuestionResponse",
+          "declaration": {
+            "name": "readQuestionResponse",
+            "module": "src/components/ai-chat/helpers/question-template.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "questionMarkup",
+          "declaration": {
+            "name": "questionMarkup",
+            "module": "src/components/ai-chat/helpers/question-template.ts"
+          }
+        }
+      ]
+    },
     {
       "kind": "javascript-module",
       "path": "src/components/ai-chat/session/ai-chat-session-controller.ts",
@@ -3063,7 +3289,7 @@
                   "name": "options",
                   "default": "{}",
                   "type": {
-                    "text": "{ internal?: boolean }"
+                    "text": "{ internal?: boolean; answer?: AiPromptAnswer }"
                   }
                 }
               ]
@@ -3080,7 +3306,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    internal?: boolean;\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    answer?: AiPromptAnswer;\n  }"
                   }
                 }
               ],
@@ -3135,6 +3361,37 @@
               ],
               "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": "answerQuestion",
+              "return": {
+                "type": {
+                  "text": "Promise<boolean>"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "messageId",
+                  "type": {
+                    "text": "string"
+                  }
+                },
+                {
+                  "name": "response",
+                  "type": {
+                    "text": "ChatQuestionResponse"
+                  }
+                },
+                {
+                  "name": "params",
+                  "default": "{}",
+                  "type": {
+                    "text": "Omit<AiChatSessionSubmitParams, 'prompt' | 'skipUserMessage'>"
+                  }
+                }
+              ],
+              "description": "Answer or skip the choice questions on the last message. The reply goes out as `properties.answer` with no\nprompt text and no user message; the answered box is the visible record. Resolves to `false` without sending\nwhile a response is generating, when that message has no open questions or another message follows it, when\n`response` does not fit the questions, when the dataset requirement is not met, when the send is aborted or\nsuperseded before the request goes out, or when the API rejects the answer; the questions are open again then,\nwith `error` set when the user needs to know why."
+            },
             {
               "kind": "method",
               "name": "setMessageFeedback",
@@ -6999,6 +7256,36 @@
           "description": "",
           "name": "LuzmoDisplaySettings",
           "members": [
+            {
+              "kind": "field",
+              "name": "slotsContents",
+              "type": {
+                "text": "VizItemSlot[]"
+              },
+              "default": "[]",
+              "description": "Full saved slots for deriving comparison levels and implicit datetime offsets."
+            },
+            {
+              "kind": "field",
+              "name": "itemType",
+              "type": {
+                "text": "VizItemType | undefined"
+              },
+              "description": "Visualization type used to interpret comparison slot context.",
+              "attribute": "item-type",
+              "reflects": true
+            },
+            {
+              "kind": "field",
+              "name": "hasConnectedComparisonFilter",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Whether a comparison filter currently applies to this item. Runtime only; never saved in slot contents.",
+              "attribute": "has-connected-comparison-filter",
+              "reflects": true
+            },
             {
               "kind": "field",
               "name": "language",
@@ -7079,7 +7366,7 @@
               "type": {
                 "text": "PeriodOverPeriodCondition | null | undefined"
               },
-              "description": "Whether to show the period-over-period in numeric",
+              "description": "Optional comparison UI override for standalone use; null hides comparisons. Otherwise derived from slotsContents, itemType, filters, and datasetsDataFields.",
               "attribute": "periodOverPeriodUiType"
             },
             {
@@ -7127,7 +7414,7 @@
                 "text": "DatasetDataFields[]"
               },
               "default": "[]",
-              "description": "Datasets used to resolve column names in ad-hoc calculation previews."
+              "description": "Datasets used for calculation previews and standalone comparison offset date choices (columns or dataFields)."
             },
             {
               "kind": "field",
@@ -7229,6 +7516,23 @@
             }
           ],
           "attributes": [
+            {
+              "name": "item-type",
+              "type": {
+                "text": "VizItemType | undefined"
+              },
+              "description": "Visualization type used to interpret comparison slot context.",
+              "fieldName": "itemType"
+            },
+            {
+              "name": "has-connected-comparison-filter",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Whether a comparison filter currently applies to this item. Runtime only; never saved in slot contents.",
+              "fieldName": "hasConnectedComparisonFilter"
+            },
             {
               "name": "language",
               "type": {
@@ -7300,7 +7604,7 @@
               "type": {
                 "text": "PeriodOverPeriodCondition | null | undefined"
               },
-              "description": "Whether to show the period-over-period in numeric",
+              "description": "Optional comparison UI override for standalone use; null hides comparisons. Otherwise derived from slotsContents, itemType, filters, and datasetsDataFields.",
               "fieldName": "periodOverPeriodUiType"
             },
             {
@@ -8048,6 +8352,36 @@
           "description": "",
           "name": "LuzmoDisplaySettingsPeriodOverPeriod",
           "members": [
+            {
+              "kind": "field",
+              "name": "slotsContents",
+              "type": {
+                "text": "VizItemSlot[]"
+              },
+              "default": "[]",
+              "description": "Full saved slots for deriving comparison levels and implicit datetime offsets."
+            },
+            {
+              "kind": "field",
+              "name": "itemType",
+              "type": {
+                "text": "VizItemType | undefined"
+              },
+              "description": "Visualization type used to interpret comparison slot context.",
+              "attribute": "item-type",
+              "reflects": true
+            },
+            {
+              "kind": "field",
+              "name": "hasConnectedComparisonFilter",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Whether a comparison filter currently applies to this item. Runtime only; never saved in slot contents.",
+              "attribute": "has-connected-comparison-filter",
+              "reflects": true
+            },
             {
               "kind": "field",
               "name": "slotContent",
@@ -8062,19 +8396,18 @@
               "kind": "field",
               "name": "periodOverPeriodUiType",
               "type": {
-                "text": "PeriodOverPeriodCondition"
+                "text": "PeriodOverPeriodCondition | undefined"
               },
-              "description": "Which period-over-period UI variant to render, based on available datetime columns and comparison filters.",
+              "description": "Optional UI variant supplied by a parent. When absent, derive it from runtime slot and filter context.",
               "attribute": "period-over-period-type"
             },
             {
               "kind": "field",
               "name": "allowPeriodsWithoutDatetimeColumn",
               "type": {
-                "text": "boolean"
+                "text": "boolean | undefined"
               },
-              "default": "false",
-              "description": "Offer the \"Periods\" offset when there is no datetime category (an offset date column is needed). The item\nthen shifts by the length of the period selected by its date filters.",
+              "description": "Offer the \"Periods\" offset when there is no datetime category (an offset date column is needed). The item\nthen shifts by the length of the period selected by its date filters. Defaults to true for KPIs, false otherwise.",
               "attribute": "allow-periods-without-datetime-column",
               "reflects": true
             },
@@ -8082,10 +8415,9 @@
               "kind": "field",
               "name": "hidePastValue",
               "type": {
-                "text": "boolean"
+                "text": "boolean | undefined"
               },
-              "default": "false",
-              "description": "Hide the \"Past value\" comparison type, e.g. for items that only show the change.",
+              "description": "Hide the \"Past value\" comparison type. Defaults to true for KPIs, false otherwise; explicit booleans override the default.",
               "attribute": "hide-past-value",
               "reflects": true
             },
@@ -8099,15 +8431,6 @@
               "description": "Datetime columns from the linked dataset available as offset/comparison date columns.",
               "attribute": "linked-dataset-datetime-columns"
             },
-            {
-              "kind": "method",
-              "name": "renderOldUi",
-              "return": {
-                "type": {
-                  "text": "TemplateResult"
-                }
-              }
-            },
             {
               "kind": "field",
               "name": "language",
@@ -8148,6 +8471,23 @@
             }
           ],
           "attributes": [
+            {
+              "name": "item-type",
+              "type": {
+                "text": "VizItemType | undefined"
+              },
+              "description": "Visualization type used to interpret comparison slot context.",
+              "fieldName": "itemType"
+            },
+            {
+              "name": "has-connected-comparison-filter",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Whether a comparison filter currently applies to this item. Runtime only; never saved in slot contents.",
+              "fieldName": "hasConnectedComparisonFilter"
+            },
             {
               "name": "slot-content",
               "type": {
@@ -8160,27 +8500,25 @@
             {
               "name": "period-over-period-type",
               "type": {
-                "text": "PeriodOverPeriodCondition"
+                "text": "PeriodOverPeriodCondition | undefined"
               },
-              "description": "Which period-over-period UI variant to render, based on available datetime columns and comparison filters.",
+              "description": "Optional UI variant supplied by a parent. When absent, derive it from runtime slot and filter context.",
               "fieldName": "periodOverPeriodUiType"
             },
             {
               "name": "allow-periods-without-datetime-column",
               "type": {
-                "text": "boolean"
+                "text": "boolean | undefined"
               },
-              "default": "false",
-              "description": "Offer the \"Periods\" offset when there is no datetime category (an offset date column is needed). The item\nthen shifts by the length of the period selected by its date filters.",
+              "description": "Offer the \"Periods\" offset when there is no datetime category (an offset date column is needed). The item\nthen shifts by the length of the period selected by its date filters. Defaults to true for KPIs, false otherwise.",
               "fieldName": "allowPeriodsWithoutDatetimeColumn"
             },
             {
               "name": "hide-past-value",
               "type": {
-                "text": "boolean"
+                "text": "boolean | undefined"
               },
-              "default": "false",
-              "description": "Hide the \"Past value\" comparison type, e.g. for items that only show the change.",
+              "description": "Hide the \"Past value\" comparison type. Defaults to true for KPIs, false otherwise; explicit booleans override the default.",
               "fieldName": "hidePastValue"
             },
             {
@@ -20700,6 +21038,17 @@
           "description": "",
           "name": "LuzmoItemSlotDrop",
           "members": [
+            {
+              "kind": "field",
+              "name": "hasConnectedComparisonFilter",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Whether a comparison filter currently applies to this item. Runtime only; never saved in slot contents.",
+              "attribute": "has-connected-comparison-filter",
+              "reflects": true
+            },
             {
               "kind": "field",
               "name": "itemType",
@@ -20929,6 +21278,15 @@
             }
           ],
           "attributes": [
+            {
+              "name": "has-connected-comparison-filter",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Whether a comparison filter currently applies to this item. Runtime only; never saved in slot contents.",
+              "fieldName": "hasConnectedComparisonFilter"
+            },
             {
               "name": "item-type",
               "type": {
@@ -21121,6 +21479,17 @@
           "description": "",
           "name": "LuzmoItemSlotDropPanel",
           "members": [
+            {
+              "kind": "field",
+              "name": "hasConnectedComparisonFilter",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Whether a comparison filter currently applies to this item. Runtime only; never saved in slot contents.",
+              "attribute": "has-connected-comparison-filter",
+              "reflects": true
+            },
             {
               "kind": "field",
               "name": "itemType",
@@ -21369,6 +21738,15 @@
             }
           ],
           "attributes": [
+            {
+              "name": "has-connected-comparison-filter",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Whether a comparison filter currently applies to this item. Runtime only; never saved in slot contents.",
+              "fieldName": "hasConnectedComparisonFilter"
+            },
             {
               "name": "item-type",
               "type": {
@@ -21548,6 +21926,10 @@
         {
           "kind": "variable",
           "name": "originalSlotsContents"
+        },
+        {
+          "kind": "variable",
+          "name": "updatedSlotsContents"
         }
       ],
       "exports": [
@@ -21584,6 +21966,26 @@
             }
           ],
           "members": [
+            {
+              "kind": "field",
+              "name": "slotsContents",
+              "type": {
+                "text": "VizItemSlot[]"
+              },
+              "default": "[]",
+              "description": "Full saved slots for deriving comparison levels and implicit datetime offsets."
+            },
+            {
+              "kind": "field",
+              "name": "hasConnectedComparisonFilter",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Whether a comparison filter currently applies to this item. Runtime only; never saved in slot contents.",
+              "attribute": "has-connected-comparison-filter",
+              "reflects": true
+            },
             {
               "kind": "field",
               "name": "apiUrl",
@@ -21868,6 +22270,15 @@
             }
           ],
           "attributes": [
+            {
+              "name": "has-connected-comparison-filter",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Whether a comparison filter currently applies to this item. Runtime only; never saved in slot contents.",
+              "fieldName": "hasConnectedComparisonFilter"
+            },
             {
               "name": "api-url",
               "type": {
@@ -22125,6 +22536,17 @@
           "description": "",
           "name": "LuzmoItemSlotPickerPanel",
           "members": [
+            {
+              "kind": "field",
+              "name": "hasConnectedComparisonFilter",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Whether a comparison filter currently applies to this item. Runtime only; never saved in slot contents.",
+              "attribute": "has-connected-comparison-filter",
+              "reflects": true
+            },
             {
               "kind": "field",
               "name": "itemType",
@@ -22522,6 +22944,15 @@
             }
           ],
           "attributes": [
+            {
+              "name": "has-connected-comparison-filter",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Whether a comparison filter currently applies to this item. Runtime only; never saved in slot contents.",
+              "fieldName": "hasConnectedComparisonFilter"
+            },
             {
               "name": "item-type",
               "type": {
@@ -22744,6 +23175,10 @@
         {
           "kind": "variable",
           "name": "originalSlotsContents"
+        },
+        {
+          "kind": "variable",
+          "name": "updatedSlotsContents"
         }
       ],
       "exports": [
@@ -22766,6 +23201,25 @@
           "description": "",
           "name": "LuzmoSlotMenu",
           "members": [
+            {
+              "kind": "field",
+              "name": "slotsContents",
+              "type": {
+                "text": "VizItemSlot[] | undefined"
+              },
+              "description": "Full saved slots for deriving comparison levels and implicit datetime offsets."
+            },
+            {
+              "kind": "field",
+              "name": "hasConnectedComparisonFilter",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Whether a comparison filter currently applies to this item. Runtime only; never saved in slot contents.",
+              "attribute": "has-connected-comparison-filter",
+              "reflects": true
+            },
             {
               "kind": "field",
               "name": "language",
@@ -23127,6 +23581,15 @@
             }
           ],
           "attributes": [
+            {
+              "name": "has-connected-comparison-filter",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Whether a comparison filter currently applies to this item. Runtime only; never saved in slot contents.",
+              "fieldName": "hasConnectedComparisonFilter"
+            },
             {
               "name": "language",
               "type": {