@carbon/ai-chat-components 1.2.0 → 1.3.0-rc.0

package/custom-elements.json

@@ -992,6 +992,130 @@
         }
       ]
     },
+    {
+      "kind": "javascript-module",
+      "path": "src/components/shared/dynamic-css-var-sheet.ts",
+      "declarations": [
+        {
+          "kind": "function",
+          "name": "adoptOnRoot",
+          "return": {
+            "type": {
+              "text": "void"
+            }
+          },
+          "parameters": [
+            {
+              "name": "root",
+              "type": {
+                "text": "Document | ShadowRoot"
+              }
+            }
+          ],
+          "description": "Adopt the shared dynamic stylesheet on a root so its rules apply within\nthat tree. Idempotent per root."
+        },
+        {
+          "kind": "function",
+          "name": "setVarsForSelector",
+          "return": {
+            "type": {
+              "text": "void"
+            }
+          },
+          "parameters": [
+            {
+              "name": "selector",
+              "type": {
+                "text": "string"
+              }
+            },
+            {
+              "name": "vars",
+              "type": {
+                "text": "Record<string, string>"
+              }
+            }
+          ],
+          "description": "Merge CSS declarations into the rule for a selector. Multiple subsystems\ncan write disjoint properties for the same selector without clobbering\neach other; existing properties are updated, new ones appended.\n\nThe keys can be CSS custom properties (e.g. `--cds-aichat-foo`) or any\nregular CSS property (`display`, `transform`, …)."
+        },
+        {
+          "kind": "function",
+          "name": "clearSelector",
+          "return": {
+            "type": {
+              "text": "void"
+            }
+          },
+          "parameters": [
+            {
+              "name": "selector",
+              "type": {
+                "text": "string"
+              }
+            }
+          ],
+          "description": "Remove the entire rule for a selector."
+        },
+        {
+          "kind": "function",
+          "name": "clearVarsForSelector",
+          "return": {
+            "type": {
+              "text": "void"
+            }
+          },
+          "parameters": [
+            {
+              "name": "selector",
+              "type": {
+                "text": "string"
+              }
+            },
+            {
+              "name": "props",
+              "type": {
+                "text": "string[]"
+              }
+            }
+          ],
+          "description": "Remove specific properties from a selector's rule, leaving any others\nintact. If the rule ends up empty, it is dropped."
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "adoptOnRoot",
+          "declaration": {
+            "name": "adoptOnRoot",
+            "module": "src/components/shared/dynamic-css-var-sheet.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "setVarsForSelector",
+          "declaration": {
+            "name": "setVarsForSelector",
+            "module": "src/components/shared/dynamic-css-var-sheet.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "clearSelector",
+          "declaration": {
+            "name": "clearSelector",
+            "module": "src/components/shared/dynamic-css-var-sheet.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "clearVarsForSelector",
+          "declaration": {
+            "name": "clearVarsForSelector",
+            "module": "src/components/shared/dynamic-css-var-sheet.ts"
+          }
+        }
+      ]
+    },
     {
       "kind": "javascript-module",
       "path": "src/components/table/index.ts",
@@ -1392,6 +1516,32 @@
         }
       ]
     },
+    {
+      "kind": "javascript-module",
+      "path": "src/globals/utils/rtl-utils.ts",
+      "declarations": [
+        {
+          "kind": "function",
+          "name": "isDirectionRTL",
+          "return": {
+            "type": {
+              "text": ""
+            }
+          },
+          "description": "Determines if the document is in RTL (right-to-left) mode.\nChecks both document.dir and document.documentElement.dir for maximum compatibility."
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "isDirectionRTL",
+          "declaration": {
+            "name": "isDirectionRTL",
+            "module": "src/globals/utils/rtl-utils.ts"
+          }
+        }
+      ]
+    },
     {
       "kind": "javascript-module",
       "path": "src/globals/utils/uuid.ts",
@@ -3727,27 +3877,22 @@
             },
             {
               "kind": "field",
-              "name": "_hasResultsCount",
+              "name": "resultsLabel",
               "type": {
-                "text": "boolean"
+                "text": "string"
               },
-              "privacy": "private",
-              "default": "false",
-              "description": "Tracks whether the results-count slot has content"
+              "default": "\"Results\"",
+              "description": "Label to display before the results count",
+              "attribute": "results-label"
             },
             {
-              "kind": "method",
-              "name": "_handleResultsCountSlotChange",
-              "privacy": "private",
-              "parameters": [
-                {
-                  "name": "e",
-                  "type": {
-                    "text": "Event"
-                  }
-                }
-              ],
-              "description": "Handle slot change to detect if results-count has content"
+              "kind": "field",
+              "name": "resultsCount",
+              "type": {
+                "text": "string | number | undefined"
+              },
+              "description": "The results count to display",
+              "attribute": "results-count"
             }
           ],
           "attributes": [
@@ -3759,6 +3904,23 @@
               "default": "\"content\"",
               "description": "Sets default slot value to content",
               "fieldName": "slot"
+            },
+            {
+              "name": "results-label",
+              "type": {
+                "text": "string"
+              },
+              "default": "\"Results\"",
+              "description": "Label to display before the results count",
+              "fieldName": "resultsLabel"
+            },
+            {
+              "name": "results-count",
+              "type": {
+                "text": "string | number | undefined"
+              },
+              "description": "The results count to display",
+              "fieldName": "resultsCount"
             }
           ],
           "superclass": {
@@ -4453,6 +4615,17 @@
               "description": "Overflow tooltip label",
               "attribute": "overflow-menu-label"
             },
+            {
+              "kind": "field",
+              "name": "showActions",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "`true` to always show the actions menu for this item.\nWhen set, the actions menu will be visible without requiring hover or selection.\nCan be set directly on the item or inherited from the parent panel's `show-actions` attribute.",
+              "attribute": "show-actions",
+              "reflects": true
+            },
             {
               "kind": "field",
               "name": "input",
@@ -4474,6 +4647,61 @@
                 "text": "HTMLElement"
               }
             },
+            {
+              "kind": "field",
+              "name": "_overflowMenuBodyElement",
+              "type": {
+                "text": "HTMLElement | undefined"
+              },
+              "privacy": "private"
+            },
+            {
+              "kind": "field",
+              "name": "_overflowMenuBodyFlippedClass",
+              "privacy": "private",
+              "default": "`${prefix}--history-overflow-menu-body--flipped`"
+            },
+            {
+              "kind": "field",
+              "name": "_overflowMenuBodyFlippedSelector",
+              "privacy": "private",
+              "default": "`cds-overflow-menu-body.${this._overflowMenuBodyFlippedClass}`"
+            },
+            {
+              "kind": "method",
+              "name": "_adoptOverflowMenuBodyStyles",
+              "privacy": "private",
+              "parameters": [
+                {
+                  "name": "overflowMenuBody",
+                  "type": {
+                    "text": "HTMLElement"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "_adoptOverflowMenuBodyStylesAfterPortal",
+              "privacy": "private",
+              "parameters": [
+                {
+                  "name": "overflowMenuBody",
+                  "type": {
+                    "text": "HTMLElement"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "field",
+              "name": "_parentObserver",
+              "type": {
+                "text": "MutationObserver | undefined"
+              },
+              "privacy": "private",
+              "description": "MutationObserver to watch for changes to parent panel's always-show-actions attribute"
+            },
             {
               "kind": "method",
               "name": "_adjustMenuPosition",
@@ -4578,6 +4806,15 @@
               "default": "\"Options\"",
               "description": "Overflow tooltip label",
               "fieldName": "overflowMenuLabel"
+            },
+            {
+              "name": "show-actions",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "`true` to always show the actions menu for this item.\nWhen set, the actions menu will be visible without requiring hover or selection.\nCan be set directly on the item or inherited from the parent panel's `show-actions` attribute.",
+              "fieldName": "showActions"
             }
           ],
           "mixins": [
@@ -4717,6 +4954,17 @@
               "default": "true",
               "description": "Sets default property from side nav",
               "attribute": "expanded"
+            },
+            {
+              "kind": "field",
+              "name": "showActions",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "`true` to always show the actions menu on all child history panel items.\nWhen set, the actions menu will be visible without requiring hover or selection.\nIndividual items can override this with their own `show-actions` attribute.",
+              "attribute": "show-actions",
+              "reflects": true
             }
           ],
           "attributes": [
@@ -4737,6 +4985,15 @@
               "default": "true",
               "description": "Sets default property from side nav",
               "fieldName": "expanded"
+            },
+            {
+              "name": "show-actions",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "`true` to always show the actions menu on all child history panel items.\nWhen set, the actions menu will be visible without requiring hover or selection.\nIndividual items can override this with their own `show-actions` attribute.",
+              "fieldName": "showActions"
             }
           ],
           "superclass": {
@@ -4964,6 +5221,15 @@
               "attribute": "search-off",
               "reflects": true
             },
+            {
+              "kind": "field",
+              "name": "closeButtonLabelText",
+              "type": {
+                "text": "string"
+              },
+              "default": "\"Clear search\"",
+              "attribute": "close-button-label-text"
+            },
             {
               "kind": "field",
               "name": "_handleNewChatButtonClick",
@@ -4993,6 +5259,14 @@
               "name": "search-off",
               "description": "`true` to remove search from toolbar.",
               "fieldName": "searchOff"
+            },
+            {
+              "name": "close-button-label-text",
+              "type": {
+                "text": "string"
+              },
+              "default": "\"Clear search\"",
+              "fieldName": "closeButtonLabelText"
             }
           ],
           "superclass": {
@@ -5597,7 +5871,7 @@
       "declarations": [
         {
           "kind": "class",
-          "description": "Manages rounded corner calculations and CSS variable updates for the chat shell.\nHandles the logic for determining effective corner styles and applying them\nto CSS custom properties.",
+          "description": "Manages rounded corner calculations and CSS variable updates for the chat shell.\nHandles the logic for determining effective corner styles and applying them\nto CSS custom properties via the shared dynamic stylesheet (CSP-safe).",
           "name": "CornerManager",
           "members": [
             {
@@ -5627,6 +5901,16 @@
               ],
               "description": "Update corner configuration and apply CSS variables"
             },
+            {
+              "kind": "method",
+              "name": "destroy",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "description": "Drop the shell's corner-radius rules from the dynamic stylesheet."
+            },
             {
               "kind": "method",
               "name": "hasAnyRoundedCorner",
@@ -6843,6 +7127,15 @@
               "attribute": "content-max-width",
               "reflects": true
             },
+            {
+              "kind": "field",
+              "name": "_shellSelector",
+              "type": {
+                "text": "string"
+              },
+              "privacy": "private",
+              "readonly": true
+            },
             {
               "kind": "field",
               "name": "hasHeaderAfterContent",
@@ -8796,6 +9089,15 @@
               "default": "defaultLineCountText",
               "description": "The function used to format the line count text.\nReceives the line count and returns a formatted string.\nDefaults to `${count} lines` in en-US."
             },
+            {
+              "kind": "field",
+              "name": "_snippetSelector",
+              "type": {
+                "text": "string"
+              },
+              "privacy": "private",
+              "readonly": true
+            },
             {
               "kind": "method",
               "name": "adoptLightDomCode",
@@ -8890,13 +9192,13 @@
                   }
                 }
               ],
-              "description": "Calculates the CSS custom properties for the snippet container based on expanded state and min/max row constraints.\nCSP-compliant: returns properties to be set via element.style.setProperty()"
+              "description": "Calculates the CSS custom properties for the snippet container based on expanded state and min/max row constraints.\nReturned by reference for `_applyContainerStyles`, which writes them via the shared dynamic stylesheet\n(see `dynamic-css-var-sheet`) so a strict CSP can drop `style-src-attr 'unsafe-inline'`."
             },
             {
               "kind": "method",
               "name": "_applyContainerStyles",
               "privacy": "private",
-              "description": "Applies CSS custom properties to the snippet container element.\nCSP-compliant: uses setProperty() instead of inline style attribute."
+              "description": "Applies CSS custom properties to the snippet container element via the\nshared dynamic stylesheet so a strict CSP can drop\nstyle-src-attr 'unsafe-inline'. The container is tagged with a\nper-instance data attribute so each snippet's rule is independent."
             },
             {
               "kind": "method",
@@ -9874,23 +10176,23 @@
             },
             {
               "kind": "field",
-              "name": "placeholder",
+              "name": "disclaimerCheckbox",
               "type": {
-                "text": "string"
+                "text": "string | undefined"
               },
-              "default": "\"Provide additional feedback...\"",
-              "description": "The placeholder to show in the text area. A default value will be used if no value is provided here.",
-              "attribute": "text-area-placeholder",
+              "description": "The label text to display with the disclaimer checkbox. If this value is not provided, no checkbox or label text will be displayed.",
+              "attribute": "disclaimer-checkbox",
               "reflects": true
             },
             {
               "kind": "field",
-              "name": "secondaryLabel",
+              "name": "placeholder",
               "type": {
-                "text": "string | undefined"
+                "text": "string"
               },
-              "description": "The label for the secondary button. A default value will be used if no value is provided here.",
-              "attribute": "secondary-label",
+              "default": "\"Provide additional feedback...\"",
+              "description": "The placeholder to show in the text area. A default value will be used if no value is provided here.",
+              "attribute": "text-area-placeholder",
               "reflects": true
             },
             {
@@ -9935,6 +10237,15 @@
               "attribute": "show-body",
               "reflects": true
             },
+            {
+              "kind": "field",
+              "name": "_isSubmitDisabled",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Indicates if the submit feedback button is disabled."
+            },
             {
               "kind": "method",
               "name": "_setInitialValues",
@@ -9985,6 +10296,19 @@
                 }
               ],
               "description": "Called when a category button is clicked."
+            },
+            {
+              "kind": "method",
+              "name": "_handleDisclaimerCheckboxChange",
+              "parameters": [
+                {
+                  "name": "event",
+                  "type": {
+                    "text": "Event"
+                  }
+                }
+              ],
+              "description": "Called when the disclaimer checkbox state changes."
             }
           ],
           "events": [
@@ -10062,6 +10386,14 @@
               "description": "The legal disclaimer text to show at the bottom of the popup. This text may contain rich markdown content. If this\nvalue is not provided, no text will be shown.",
               "fieldName": "disclaimer"
             },
+            {
+              "name": "disclaimer-checkbox",
+              "type": {
+                "text": "string | undefined"
+              },
+              "description": "The label text to display with the disclaimer checkbox. If this value is not provided, no checkbox or label text will be displayed.",
+              "fieldName": "disclaimerCheckbox"
+            },
             {
               "name": "text-area-placeholder",
               "type": {
@@ -10071,14 +10403,6 @@
               "description": "The placeholder to show in the text area. A default value will be used if no value is provided here.",
               "fieldName": "placeholder"
             },
-            {
-              "name": "secondary-label",
-              "type": {
-                "text": "string | undefined"
-              },
-              "description": "The label for the secondary button. A default value will be used if no value is provided here.",
-              "fieldName": "secondaryLabel"
-            },
             {
               "name": "primary-label",
               "type": {
@@ -12300,6 +12624,27 @@
               },
               "privacy": "private"
             },
+            {
+              "kind": "field",
+              "name": "_truncatedInstanceId",
+              "privacy": "private",
+              "readonly": true,
+              "default": "`tt-${++truncatedInstanceCounter}`"
+            },
+            {
+              "kind": "field",
+              "name": "_truncatedSelector",
+              "type": {
+                "text": "string"
+              },
+              "privacy": "private",
+              "readonly": true
+            },
+            {
+              "kind": "method",
+              "name": "_syncTruncatedVars",
+              "privacy": "private"
+            },
             {
               "kind": "method",
               "name": "_updateMaxHeight",
@@ -12655,6 +13000,32 @@
               "privacy": "private",
               "default": "false"
             },
+            {
+              "kind": "field",
+              "name": "instanceId",
+              "privacy": "private",
+              "readonly": true,
+              "default": "`vp-${++instanceCounter}`"
+            },
+            {
+              "kind": "field",
+              "name": "instanceSelector",
+              "type": {
+                "text": "string"
+              },
+              "privacy": "private",
+              "readonly": true
+            },
+            {
+              "kind": "method",
+              "name": "syncAspectRatioVar",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              }
+            },
             {
               "kind": "method",
               "name": "createProvider",