@ui5/webcomponents-ai 0.0.0-95afb1087 → 0.0.0-a8a75c830

package/dist/custom-elements-internal.json

@@ -193,7 +193,7 @@
           },
           "tagName": "ui5-ai-button",
           "customElement": true,
-          "_ui5experimental": "The Button and ButtonState web components are availabe since 2.0 under an experimental flag and their API and behaviour are subject to change.",
+          "_ui5experimental": "The **@ui5/webcomponents-ai** package (including Button and ButtonState) is under active development and considered experimental. Component APIs are subject to change.\nFurthermore, the package supports **Horizon** themes only.",
           "_ui5since": "2.0.0",
           "_ui5privacy": "public"
         }
@@ -332,7 +332,7 @@
           },
           "tagName": "ui5-ai-button-state",
           "customElement": true,
-          "_ui5experimental": "The Button and ButtonState web components are available since 2.0 under an experimental flag and their API and behaviour are subject to change.",
+          "_ui5experimental": "The **@ui5/webcomponents-ai** package (including ButtonState) is under active development and considered experimental. Component APIs are subject to change.\nFurthermore, the package supports **Horizon** themes only.",
           "_ui5since": "2.0.0",
           "_ui5privacy": "public",
           "_ui5abstract": true
@@ -423,12 +423,37 @@
               "name": "item-click",
               "_ui5privacy": "public",
               "type": {
-                "text": "CustomEvent"
+                "text": "CustomEvent<InputItemClickEventDetail>",
+                "references": [
+                  {
+                    "name": "InputItemClickEventDetail",
+                    "package": "@ui5/webcomponents-ai",
+                    "module": "dist/Input.js"
+                  }
+                ]
               },
               "description": "Fired when an item from the AI actions menu is clicked.",
               "_ui5Cancelable": false,
               "_ui5allowPreventDefault": false,
-              "_ui5Bubbles": false
+              "_ui5Bubbles": false,
+              "_ui5parameters": [
+                {
+                  "type": {
+                    "text": "HTMLElement"
+                  },
+                  "name": "item",
+                  "_ui5privacy": "public",
+                  "description": "The currently clicked menu item."
+                },
+                {
+                  "type": {
+                    "text": "string"
+                  },
+                  "name": "text",
+                  "_ui5privacy": "public",
+                  "description": "The text of the currently clicked menu item."
+                }
+              ]
             },
             {
               "name": "stop-generation",
@@ -506,7 +531,7 @@
           },
           "tagName": "ui5-ai-input",
           "customElement": true,
-          "_ui5experimental": "The **@ui5/webcomponents-ai** package is under active development and considered experimental. Component APIs are subject to change.",
+          "_ui5experimental": "The **@ui5/webcomponents-ai** package is under active development and considered experimental. Component APIs are subject to change.\nFurthermore, the package supports **Horizon** themes only.",
           "_ui5since": "2.16.0",
           "_ui5privacy": "public"
         }
@@ -820,7 +845,7 @@
           },
           "tagName": "ui5-ai-prompt-input",
           "customElement": true,
-          "_ui5experimental": "The **@ui5/webcomponents-ai** package is under development and considered experimental - components' APIs are subject to change.",
+          "_ui5experimental": "The **@ui5/webcomponents-ai** package is under development and considered experimental - components' APIs are subject to change.\nFurthermore, the package supports **Horizon** themes only.",
           "_ui5privacy": "public"
         }
       ],
@@ -989,7 +1014,7 @@
           },
           "tagName": "ui5-ai-textarea",
           "customElement": true,
-          "_ui5experimental": "The **@ui5/webcomponents-ai** package is under development and considered experimental - components' APIs are subject to change.",
+          "_ui5experimental": "The **@ui5/webcomponents-ai** package is under development and considered experimental - components' APIs are subject to change.\nFurthermore, the package supports **Horizon** themes only.",
           "_ui5since": "2.16.0",
           "_ui5privacy": "public"
         }
@@ -1016,7 +1041,45 @@
     {
       "kind": "javascript-module",
       "path": "dist/ToolbarLabel.js",
-      "declarations": [],
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "### Overview\nThe `ui5-ai-toolbar-label` represents a text label,\nused in the `ui5-toolbar`.\n\n### ES6 Module Import\n`import \"@ui5/webcomponents-ai/dist/ToolbarLabel.js\";`",
+          "name": "ToolbarLabel",
+          "members": [
+            {
+              "kind": "field",
+              "name": "text",
+              "type": {
+                "text": "string"
+              },
+              "default": "\"\"",
+              "description": "Defines the text of the label.",
+              "privacy": "public"
+            }
+          ],
+          "attributes": [
+            {
+              "description": "Defines the text of the label.",
+              "name": "text",
+              "default": "\"\"",
+              "fieldName": "text",
+              "type": {
+                "text": "string"
+              }
+            }
+          ],
+          "superclass": {
+            "name": "ToolbarItem",
+            "package": "@ui5/webcomponents",
+            "module": "dist/ToolbarItem.js"
+          },
+          "tagName": "ui5-ai-toolbar-label",
+          "customElement": true,
+          "_ui5since": "1.0.0-rc.1",
+          "_ui5privacy": "private"
+        }
+      ],
       "exports": [
         {
           "kind": "js",
@@ -1025,13 +1088,91 @@
             "name": "ToolbarLabel",
             "module": "dist/ToolbarLabel.js"
           }
+        },
+        {
+          "kind": "custom-element-definition",
+          "name": "ui5-ai-toolbar-label",
+          "declaration": {
+            "name": "ToolbarLabel",
+            "module": "dist/ToolbarLabel.js"
+          }
         }
       ]
     },
     {
       "kind": "javascript-module",
       "path": "dist/Versioning.js",
-      "declarations": [],
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "### Overview\n\nThe `ui5-ai-versioning` component provides navigation controls for AI-generated content versions.\nIt displays the current version index and total versions, with previous/next navigation buttons.\nThis component extends ToolbarItem to participate in toolbar overflow behavior as a single unit.\n\n### Structure\nThe `ui5-ai-versioning` consists of the following elements:\n- Previous Button: Navigates to the previous version (disabled when at first version)\n- Version Counter: Shows current version / total versions (e.g., \"2 / 5\")\n- Next Button: Navigates to the nex\nt version (disabled when at last version)\n\n### Focus Management\nThe component automatically manages focus when users reach version boundaries,\nmoving focus to the available navigation button when one becomes disabled.\n\n### Responsive Behavior\nWhen used in a toolbar, the entire versioning component (buttons + label) will overflow\ntogether as a single unit when there is insufficient space.\n\n### ES6 Module Import\n\n`import \"@ui5/webcomponents-ai/dist/Versioning.js\";`",
+          "name": "Versioning",
+          "members": [
+            {
+              "kind": "field",
+              "name": "currentStep",
+              "type": {
+                "text": "number"
+              },
+              "default": "0",
+              "description": "Indicates the index of the currently displayed result version.\n\nThis property represents the current position in the version history.",
+              "privacy": "public"
+            },
+            {
+              "kind": "field",
+              "name": "totalSteps",
+              "type": {
+                "text": "number"
+              },
+              "default": "0",
+              "description": "The total number of available result versions.\n\nNote: Versioning is hidden if the value is `0`.",
+              "privacy": "public"
+            }
+          ],
+          "events": [
+            {
+              "name": "version-change",
+              "_ui5privacy": "public",
+              "type": {
+                "text": "CustomEvent"
+              },
+              "description": "Fired when the user clicks on version navigation buttons.",
+              "_ui5Cancelable": false,
+              "_ui5allowPreventDefault": false,
+              "_ui5Bubbles": false
+            }
+          ],
+          "attributes": [
+            {
+              "description": "Indicates the index of the currently displayed result version.\n\nThis property represents the current position in the version history.",
+              "name": "current-step",
+              "default": "0",
+              "fieldName": "currentStep",
+              "type": {
+                "text": "number"
+              }
+            },
+            {
+              "description": "The total number of available result versions.\n\nNote: Versioning is hidden if the value is `0`.",
+              "name": "total-steps",
+              "default": "0",
+              "fieldName": "totalSteps",
+              "type": {
+                "text": "number"
+              }
+            }
+          ],
+          "superclass": {
+            "name": "ToolbarItem",
+            "package": "@ui5/webcomponents",
+            "module": "dist/ToolbarItem.js"
+          },
+          "tagName": "ui5-ai-versioning",
+          "customElement": true,
+          "_ui5since": "2.16.0",
+          "_ui5privacy": "private"
+        }
+      ],
       "exports": [
         {
           "kind": "js",
@@ -1040,13 +1181,144 @@
             "name": "Versioning",
             "module": "dist/Versioning.js"
           }
+        },
+        {
+          "kind": "custom-element-definition",
+          "name": "ui5-ai-versioning",
+          "declaration": {
+            "name": "Versioning",
+            "module": "dist/Versioning.js"
+          }
         }
       ]
     },
     {
       "kind": "javascript-module",
       "path": "dist/WritingAssistant.js",
-      "declarations": [],
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "### Overview\n\nThe `ui5-ai-textarea-toolbar` component provides a specialized toolbar for AI TextArea functionality.\nIt manages different states of the AI assistant and provides version navigation capabilities.\n\n### Structure\nThe `ui5-ai-textarea-toolbar` consists of the following elements:\n- AI Generate Button: Triggers AI text generation or stops ongoing generation\n- Version Navigation: Allows navigation between multiple AI-generated results\n- Action Label: Displays the current AI action being performed\n\n### ES6 Module Import\n\n`import \"@sap-webcomponents/ai/dist/WritingAssistant.js\";`",
+          "name": "WritingAssistant",
+          "members": [
+            {
+              "kind": "field",
+              "name": "promptDescription",
+              "type": {
+                "text": "string"
+              },
+              "default": "\"\"",
+              "description": "Defines the prompt description of the Writing Assistant.\n\nThis text is displayed in the toolbar to indicate the current or last\nperformed AI action (e.g., \"Generated text\", \"Simplified text\").",
+              "privacy": "public"
+            },
+            {
+              "kind": "field",
+              "name": "currentVersion",
+              "type": {
+                "text": "number"
+              },
+              "default": "0",
+              "description": "Indicates the index of the currently displayed result version.\n\nThe index is **0-based** (i.e. `0` represents the first result).\nThis property is synchronized with the parent AI TextArea component.",
+              "privacy": "public",
+              "_ui5since": "2.16.0"
+            },
+            {
+              "kind": "field",
+              "name": "totalVersions",
+              "type": {
+                "text": "number"
+              },
+              "default": "0",
+              "description": "Indicates the total number of result versions available.\n\nThis property determines whether version navigation controls are displayed.\nWhen totalVersions > 0, previous/next buttons become available.",
+              "privacy": "public"
+            },
+            {
+              "kind": "method",
+              "name": "handleButtonClick",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "description": "Handles the click event for the AI generate button.\nToggles between generate and stop states based on current button state.",
+              "privacy": "public"
+            }
+          ],
+          "events": [
+            {
+              "name": "version-change",
+              "_ui5privacy": "public",
+              "type": {
+                "text": "CustomEvent"
+              },
+              "description": "Fired when the user clicks on version navigation buttons.",
+              "_ui5Cancelable": false,
+              "_ui5allowPreventDefault": false,
+              "_ui5Bubbles": false
+            },
+            {
+              "name": "button-click",
+              "_ui5privacy": "public",
+              "type": {
+                "text": "CustomEvent"
+              },
+              "description": "Fired when the user clicks on the AI button.",
+              "_ui5Cancelable": false,
+              "_ui5allowPreventDefault": false,
+              "_ui5Bubbles": false
+            },
+            {
+              "name": "stop-generation",
+              "_ui5privacy": "public",
+              "type": {
+                "text": "CustomEvent"
+              },
+              "description": "Fired when the user clicks on the \"Stop\" button to stop ongoing AI text generation.",
+              "_ui5Cancelable": false,
+              "_ui5allowPreventDefault": false,
+              "_ui5Bubbles": false
+            }
+          ],
+          "attributes": [
+            {
+              "description": "Defines the prompt description of the Writing Assistant.\n\nThis text is displayed in the toolbar to indicate the current or last\nperformed AI action (e.g., \"Generated text\", \"Simplified text\").",
+              "name": "prompt-description",
+              "default": "\"\"",
+              "fieldName": "promptDescription",
+              "type": {
+                "text": "string"
+              }
+            },
+            {
+              "description": "Indicates the index of the currently displayed result version.\n\nThe index is **0-based** (i.e. `0` represents the first result).\nThis property is synchronized with the parent AI TextArea component.",
+              "name": "current-version",
+              "default": "0",
+              "fieldName": "currentVersion",
+              "type": {
+                "text": "number"
+              }
+            },
+            {
+              "description": "Indicates the total number of result versions available.\n\nThis property determines whether version navigation controls are displayed.\nWhen totalVersions > 0, previous/next buttons become available.",
+              "name": "total-versions",
+              "default": "0",
+              "fieldName": "totalVersions",
+              "type": {
+                "text": "number"
+              }
+            }
+          ],
+          "superclass": {
+            "name": "UI5Element",
+            "package": "@ui5/webcomponents-base",
+            "module": "dist/UI5Element.js"
+          },
+          "tagName": "ui5-ai-writing-assistant",
+          "customElement": true,
+          "_ui5since": "2.16.0",
+          "_ui5privacy": "private"
+        }
+      ],
       "exports": [
         {
           "kind": "js",
@@ -1055,6 +1327,14 @@
             "name": "WritingAssistant",
             "module": "dist/WritingAssistant.js"
           }
+        },
+        {
+          "kind": "custom-element-definition",
+          "name": "ui5-ai-writing-assistant",
+          "declaration": {
+            "name": "WritingAssistant",
+            "module": "dist/WritingAssistant.js"
+          }
         }
       ]
     }

package/dist/custom-elements.json

@@ -383,7 +383,14 @@
             {
               "name": "item-click",
               "type": {
-                "text": "CustomEvent"
+                "text": "CustomEvent<InputItemClickEventDetail>",
+                "references": [
+                  {
+                    "name": "InputItemClickEventDetail",
+                    "package": "@ui5/webcomponents-ai",
+                    "module": "dist/Input.js"
+                  }
+                ]
               },
               "description": "Fired when an item from the AI actions menu is clicked."
             },
@@ -884,7 +891,43 @@
     {
       "kind": "javascript-module",
       "path": "dist/ToolbarLabel.js",
-      "declarations": [],
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "### Overview\nThe `ui5-ai-toolbar-label` represents a text label,\nused in the `ui5-toolbar`.\n\n### ES6 Module Import\n`import \"@ui5/webcomponents-ai/dist/ToolbarLabel.js\";`",
+          "name": "ToolbarLabel",
+          "members": [
+            {
+              "kind": "field",
+              "name": "text",
+              "type": {
+                "text": "string"
+              },
+              "default": "\"\"",
+              "description": "Defines the text of the label.",
+              "privacy": "public"
+            }
+          ],
+          "attributes": [
+            {
+              "description": "Defines the text of the label.",
+              "name": "text",
+              "default": "\"\"",
+              "fieldName": "text",
+              "type": {
+                "text": "string"
+              }
+            }
+          ],
+          "superclass": {
+            "name": "ToolbarItem",
+            "package": "@ui5/webcomponents",
+            "module": "dist/ToolbarItem.js"
+          },
+          "tagName": "ui5-ai-toolbar-label",
+          "customElement": true
+        }
+      ],
       "exports": [
         {
           "kind": "js",
@@ -893,13 +936,85 @@
             "name": "ToolbarLabel",
             "module": "dist/ToolbarLabel.js"
           }
+        },
+        {
+          "kind": "custom-element-definition",
+          "name": "ui5-ai-toolbar-label",
+          "declaration": {
+            "name": "ToolbarLabel",
+            "module": "dist/ToolbarLabel.js"
+          }
         }
       ]
     },
     {
       "kind": "javascript-module",
       "path": "dist/Versioning.js",
-      "declarations": [],
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "### Overview\n\nThe `ui5-ai-versioning` component provides navigation controls for AI-generated content versions.\nIt displays the current version index and total versions, with previous/next navigation buttons.\nThis component extends ToolbarItem to participate in toolbar overflow behavior as a single unit.\n\n### Structure\nThe `ui5-ai-versioning` consists of the following elements:\n- Previous Button: Navigates to the previous version (disabled when at first version)\n- Version Counter: Shows current version / total versions (e.g., \"2 / 5\")\n- Next Button: Navigates to the nex\nt version (disabled when at last version)\n\n### Focus Management\nThe component automatically manages focus when users reach version boundaries,\nmoving focus to the available navigation button when one becomes disabled.\n\n### Responsive Behavior\nWhen used in a toolbar, the entire versioning component (buttons + label) will overflow\ntogether as a single unit when there is insufficient space.\n\n### ES6 Module Import\n\n`import \"@ui5/webcomponents-ai/dist/Versioning.js\";`",
+          "name": "Versioning",
+          "members": [
+            {
+              "kind": "field",
+              "name": "currentStep",
+              "type": {
+                "text": "number"
+              },
+              "default": "0",
+              "description": "Indicates the index of the currently displayed result version.\n\nThis property represents the current position in the version history.",
+              "privacy": "public"
+            },
+            {
+              "kind": "field",
+              "name": "totalSteps",
+              "type": {
+                "text": "number"
+              },
+              "default": "0",
+              "description": "The total number of available result versions.\n\nNote: Versioning is hidden if the value is `0`.",
+              "privacy": "public"
+            }
+          ],
+          "events": [
+            {
+              "name": "version-change",
+              "type": {
+                "text": "CustomEvent"
+              },
+              "description": "Fired when the user clicks on version navigation buttons."
+            }
+          ],
+          "attributes": [
+            {
+              "description": "Indicates the index of the currently displayed result version.\n\nThis property represents the current position in the version history.",
+              "name": "current-step",
+              "default": "0",
+              "fieldName": "currentStep",
+              "type": {
+                "text": "number"
+              }
+            },
+            {
+              "description": "The total number of available result versions.\n\nNote: Versioning is hidden if the value is `0`.",
+              "name": "total-steps",
+              "default": "0",
+              "fieldName": "totalSteps",
+              "type": {
+                "text": "number"
+              }
+            }
+          ],
+          "superclass": {
+            "name": "ToolbarItem",
+            "package": "@ui5/webcomponents",
+            "module": "dist/ToolbarItem.js"
+          },
+          "tagName": "ui5-ai-versioning",
+          "customElement": true
+        }
+      ],
       "exports": [
         {
           "kind": "js",
@@ -908,13 +1023,129 @@
             "name": "Versioning",
             "module": "dist/Versioning.js"
           }
+        },
+        {
+          "kind": "custom-element-definition",
+          "name": "ui5-ai-versioning",
+          "declaration": {
+            "name": "Versioning",
+            "module": "dist/Versioning.js"
+          }
         }
       ]
     },
     {
       "kind": "javascript-module",
       "path": "dist/WritingAssistant.js",
-      "declarations": [],
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "### Overview\n\nThe `ui5-ai-textarea-toolbar` component provides a specialized toolbar for AI TextArea functionality.\nIt manages different states of the AI assistant and provides version navigation capabilities.\n\n### Structure\nThe `ui5-ai-textarea-toolbar` consists of the following elements:\n- AI Generate Button: Triggers AI text generation or stops ongoing generation\n- Version Navigation: Allows navigation between multiple AI-generated results\n- Action Label: Displays the current AI action being performed\n\n### ES6 Module Import\n\n`import \"@sap-webcomponents/ai/dist/WritingAssistant.js\";`",
+          "name": "WritingAssistant",
+          "members": [
+            {
+              "kind": "field",
+              "name": "promptDescription",
+              "type": {
+                "text": "string"
+              },
+              "default": "\"\"",
+              "description": "Defines the prompt description of the Writing Assistant.\n\nThis text is displayed in the toolbar to indicate the current or last\nperformed AI action (e.g., \"Generated text\", \"Simplified text\").",
+              "privacy": "public"
+            },
+            {
+              "kind": "field",
+              "name": "currentVersion",
+              "type": {
+                "text": "number"
+              },
+              "default": "0",
+              "description": "Indicates the index of the currently displayed result version.\n\nThe index is **0-based** (i.e. `0` represents the first result).\nThis property is synchronized with the parent AI TextArea component.",
+              "privacy": "public"
+            },
+            {
+              "kind": "field",
+              "name": "totalVersions",
+              "type": {
+                "text": "number"
+              },
+              "default": "0",
+              "description": "Indicates the total number of result versions available.\n\nThis property determines whether version navigation controls are displayed.\nWhen totalVersions > 0, previous/next buttons become available.",
+              "privacy": "public"
+            },
+            {
+              "kind": "method",
+              "name": "handleButtonClick",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "description": "Handles the click event for the AI generate button.\nToggles between generate and stop states based on current button state.",
+              "privacy": "public"
+            }
+          ],
+          "events": [
+            {
+              "name": "version-change",
+              "type": {
+                "text": "CustomEvent"
+              },
+              "description": "Fired when the user clicks on version navigation buttons."
+            },
+            {
+              "name": "button-click",
+              "type": {
+                "text": "CustomEvent"
+              },
+              "description": "Fired when the user clicks on the AI button."
+            },
+            {
+              "name": "stop-generation",
+              "type": {
+                "text": "CustomEvent"
+              },
+              "description": "Fired when the user clicks on the \"Stop\" button to stop ongoing AI text generation."
+            }
+          ],
+          "attributes": [
+            {
+              "description": "Defines the prompt description of the Writing Assistant.\n\nThis text is displayed in the toolbar to indicate the current or last\nperformed AI action (e.g., \"Generated text\", \"Simplified text\").",
+              "name": "prompt-description",
+              "default": "\"\"",
+              "fieldName": "promptDescription",
+              "type": {
+                "text": "string"
+              }
+            },
+            {
+              "description": "Indicates the index of the currently displayed result version.\n\nThe index is **0-based** (i.e. `0` represents the first result).\nThis property is synchronized with the parent AI TextArea component.",
+              "name": "current-version",
+              "default": "0",
+              "fieldName": "currentVersion",
+              "type": {
+                "text": "number"
+              }
+            },
+            {
+              "description": "Indicates the total number of result versions available.\n\nThis property determines whether version navigation controls are displayed.\nWhen totalVersions > 0, previous/next buttons become available.",
+              "name": "total-versions",
+              "default": "0",
+              "fieldName": "totalVersions",
+              "type": {
+                "text": "number"
+              }
+            }
+          ],
+          "superclass": {
+            "name": "UI5Element",
+            "package": "@ui5/webcomponents-base",
+            "module": "dist/UI5Element.js"
+          },
+          "tagName": "ui5-ai-writing-assistant",
+          "customElement": true
+        }
+      ],
       "exports": [
         {
           "kind": "js",
@@ -923,6 +1154,14 @@
             "name": "WritingAssistant",
             "module": "dist/WritingAssistant.js"
           }
+        },
+        {
+          "kind": "custom-element-definition",
+          "name": "ui5-ai-writing-assistant",
+          "declaration": {
+            "name": "WritingAssistant",
+            "module": "dist/WritingAssistant.js"
+          }
         }
       ]
     }