@ui5/webcomponents-ai 2.0.0-rc.4 → 2.0.0-rc.6

package/dist/custom-elements-internal.json

@@ -11,7 +11,46 @@
     {
       "kind": "javascript-module",
       "path": "dist/Button.js",
-      "declarations": [],
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "### Overview\n\nThe `ui5-ai-button` component represents a button used in AI-related scenarios.\nIt enables users to trigger actions by clicking or tapping the `ui5-ai-button`, or by pressing\ncertain keyboard keys, such as Enter.\n\n### Usage\n\nFor the `ui5-ai-button` UI, you can define one or more states of the button by placing `ai-button-state` components in its default slot.\nEach state have a key that identifies it and can have text, icon, end icon, next state and hasPopup type defined (in any combination) depending on the state purpose.\n\nYou can choose from a set of predefined designs that offer different styling to correspond to the triggered action.\n\nYou can set the `ui5-ai-button` as enabled or disabled. An enabled `ui5-ai-button` can be pressed by clicking or tapping it. On press `ui5-ai-button` changes its state to the next one (if defined).\nthe mouse cursor. A disabled `ui5-ai-button` appears inactive and cannot be pressed.\n\n### ES6 Module Import\n\n`import \"@ui5/webcomponents-ai/dist/Button.js\";`",
+          "name": "Button",
+          "members": [
+            {
+              "kind": "field",
+              "name": "disabled",
+              "type": {
+                "text": "boolean"
+              },
+              "description": "Defines whether the component is disabled.\nA disabled component can't be pressed or\nfocused, and it is not in the tab chain.",
+              "default": "false",
+              "privacy": "public",
+              "_ui5validator": "Boolean"
+            }
+          ],
+          "attributes": [
+            {
+              "description": "Defines whether the component is disabled.\nA disabled component can't be pressed or\nfocused, and it is not in the tab chain.",
+              "name": "disabled",
+              "default": "false",
+              "fieldName": "disabled",
+              "type": {
+                "text": "boolean"
+              }
+            }
+          ],
+          "superclass": {
+            "name": "UI5Element",
+            "package": "@ui5/webcomponents-base",
+            "module": "dist/UI5Element.js"
+          },
+          "tagName": "ui5-ai-button",
+          "customElement": true,
+          "_ui5since": "2.0",
+          "_ui5privacy": "public"
+        }
+      ],
       "exports": [
         {
           "kind": "js",
@@ -20,17 +59,265 @@
             "name": "Button",
             "module": "dist/Button.js"
           }
+        },
+        {
+          "kind": "custom-element-definition",
+          "name": "ui5-ai-button",
+          "declaration": {
+            "name": "Button",
+            "module": "dist/Button.js"
+          }
         }
       ]
     },
     {
       "kind": "javascript-module",
-      "path": "dist/PromtInput.js",
+      "path": "dist/PromptInput.js",
       "declarations": [
         {
           "kind": "class",
-          "description": "",
+          "description": "### Overview\n\nThe `ui5-ai-prompt-input` component allows the user to write custom instructions in natural language, so that AI is guided to generate content tailored to user needs.\n\n**Note:** The web component is in an experimental state\n\n### ES6 Module Import\n\n`import \"@ui5/webcomponents-ai/dist/PromptInput.js",
           "name": "PromptInput",
+          "slots": [
+            {
+              "name": "valueStateMessage",
+              "description": "Defines the value state message that will be displayed as pop up under the component.\nThe value state message slot should contain only one root element.\n\n**Note:** If not specified, a default text (in the respective language) will be displayed.\n\n**Note:** The `valueStateMessage` would be displayed,\nwhen the component is in `Information`, `Critical` or `Negative` value state.",
+              "_ui5since": "2.0.0",
+              "_ui5type": {
+                "text": "Array<HTMLElement>"
+              },
+              "_ui5privacy": "public"
+            }
+          ],
+          "members": [
+            {
+              "kind": "field",
+              "name": "value",
+              "type": {
+                "text": "string"
+              },
+              "description": "Defines the value of the component.",
+              "default": "\"\"",
+              "privacy": "public",
+              "_ui5since": "2.0.0",
+              "_ui5validator": "String"
+            },
+            {
+              "kind": "field",
+              "name": "placeholder",
+              "type": {
+                "text": "string"
+              },
+              "description": "Defines a short hint intended to aid the user with data entry when the\ncomponent has no value.",
+              "default": "\"\"",
+              "privacy": "public",
+              "_ui5since": "2.0.0",
+              "_ui5validator": "String"
+            },
+            {
+              "kind": "field",
+              "name": "label",
+              "type": {
+                "text": "string"
+              },
+              "description": "Defines the label of the input field.",
+              "default": "\"\"",
+              "privacy": "public",
+              "_ui5since": "2.0.0",
+              "_ui5validator": "String"
+            },
+            {
+              "kind": "field",
+              "name": "showClearIcon",
+              "type": {
+                "text": "boolean"
+              },
+              "description": "Defines whether the clear icon of the input will be shown.",
+              "default": "false",
+              "privacy": "public",
+              "_ui5since": "2.0.0",
+              "_ui5validator": "Boolean"
+            },
+            {
+              "kind": "field",
+              "name": "showExceededText",
+              "type": {
+                "text": "boolean"
+              },
+              "description": "Determines whether the characters exceeding the maximum allowed character count are visible\nin the component.\n\nIf set to `false`, the user is not allowed to enter more characters than what is set in the\n`maxlength` property.\nIf set to `true` the characters exceeding the `maxlength` value are selected on\npaste and the counter below the component displays their number.",
+              "default": "false",
+              "privacy": "public",
+              "_ui5since": "2.0.0",
+              "_ui5validator": "Boolean"
+            },
+            {
+              "kind": "field",
+              "name": "disabled",
+              "type": {
+                "text": "boolean"
+              },
+              "description": "Defines whether the component is in disabled state.\n\n**Note:** A disabled component is completely noninteractive.",
+              "default": "false",
+              "privacy": "public",
+              "_ui5since": "2.0.0",
+              "_ui5validator": "Boolean"
+            },
+            {
+              "kind": "field",
+              "name": "readonly",
+              "type": {
+                "text": "boolean"
+              },
+              "description": "Defines whether the component is read-only.\n\n**Note:** A read-only component is not editable,\nbut still provides visual feedback upon user interaction.",
+              "default": "false",
+              "privacy": "public",
+              "_ui5since": "2.0.0",
+              "_ui5validator": "Boolean"
+            },
+            {
+              "kind": "field",
+              "name": "maxlength",
+              "type": {
+                "text": "number | undefined"
+              },
+              "description": "Sets the maximum number of characters available in the input field.",
+              "default": "undefined",
+              "privacy": "public",
+              "_ui5since": "2.0.0",
+              "_ui5validator": "Integer"
+            },
+            {
+              "kind": "field",
+              "name": "valueState",
+              "type": {
+                "text": "ValueState",
+                "references": [
+                  {
+                    "name": "ValueState",
+                    "package": "@ui5/webcomponents-base",
+                    "module": "dist/types/ValueState.js"
+                  }
+                ]
+              },
+              "description": "Defines the value state of the component.",
+              "default": "\"None\"",
+              "privacy": "public",
+              "_ui5since": "2.0.0",
+              "_ui5validator": "ValueState"
+            }
+          ],
+          "events": [
+            {
+              "name": "submit",
+              "_ui5privacy": "public",
+              "type": {
+                "text": "CustomEvent"
+              },
+              "description": "Fired when the input operation has finished by pressing Enter\nor AI button is clicked.",
+              "_ui5since": "2.0.0"
+            },
+            {
+              "name": "input",
+              "_ui5privacy": "public",
+              "type": {
+                "text": "CustomEvent"
+              },
+              "description": "Fired when the value of the component changes at each keystroke,\nand when a suggestion item has been selected.",
+              "_ui5since": "2.0.0"
+            },
+            {
+              "name": "change",
+              "_ui5privacy": "public",
+              "type": {
+                "text": "CustomEvent"
+              },
+              "description": "Fired when the input operation has finished by pressing Enter\nor on focusout.",
+              "_ui5since": "2.0.0"
+            }
+          ],
+          "attributes": [
+            {
+              "description": "Defines the value of the component.",
+              "name": "value",
+              "default": "\"\"",
+              "fieldName": "value",
+              "type": {
+                "text": "string"
+              }
+            },
+            {
+              "description": "Defines a short hint intended to aid the user with data entry when the\ncomponent has no value.",
+              "name": "placeholder",
+              "default": "\"\"",
+              "fieldName": "placeholder",
+              "type": {
+                "text": "string"
+              }
+            },
+            {
+              "description": "Defines the label of the input field.",
+              "name": "label",
+              "default": "\"\"",
+              "fieldName": "label",
+              "type": {
+                "text": "string"
+              }
+            },
+            {
+              "description": "Defines whether the clear icon of the input will be shown.",
+              "name": "show-clear-icon",
+              "default": "false",
+              "fieldName": "showClearIcon",
+              "type": {
+                "text": "boolean"
+              }
+            },
+            {
+              "description": "Determines whether the characters exceeding the maximum allowed character count are visible\nin the component.\n\nIf set to `false`, the user is not allowed to enter more characters than what is set in the\n`maxlength` property.\nIf set to `true` the characters exceeding the `maxlength` value are selected on\npaste and the counter below the component displays their number.",
+              "name": "show-exceeded-text",
+              "default": "false",
+              "fieldName": "showExceededText",
+              "type": {
+                "text": "boolean"
+              }
+            },
+            {
+              "description": "Defines whether the component is in disabled state.\n\n**Note:** A disabled component is completely noninteractive.",
+              "name": "disabled",
+              "default": "false",
+              "fieldName": "disabled",
+              "type": {
+                "text": "boolean"
+              }
+            },
+            {
+              "description": "Defines whether the component is read-only.\n\n**Note:** A read-only component is not editable,\nbut still provides visual feedback upon user interaction.",
+              "name": "readonly",
+              "default": "false",
+              "fieldName": "readonly",
+              "type": {
+                "text": "boolean"
+              }
+            },
+            {
+              "description": "Sets the maximum number of characters available in the input field.",
+              "name": "maxlength",
+              "default": "undefined",
+              "fieldName": "maxlength",
+              "type": {
+                "text": "number | undefined"
+              }
+            },
+            {
+              "description": "Defines the value state of the component.",
+              "name": "value-state",
+              "default": "\"None\"",
+              "fieldName": "valueState",
+              "type": {
+                "text": "\"None\" | \"Positive\" | \"Critical\" | \"Negative\" | \"Information\""
+              }
+            }
+          ],
           "superclass": {
             "name": "UI5Element",
             "package": "@ui5/webcomponents-base",
@@ -47,7 +334,7 @@
           "name": "default",
           "declaration": {
             "name": "PromptInput",
-            "module": "dist/PromtInput.js"
+            "module": "dist/PromptInput.js"
           }
         },
         {
@@ -55,7 +342,7 @@
           "name": "ui5-ai-prompt-input",
           "declaration": {
             "name": "PromptInput",
-            "module": "dist/PromtInput.js"
+            "module": "dist/PromptInput.js"
           }
         }
       ]

package/dist/custom-elements.json

@@ -11,7 +11,43 @@
     {
       "kind": "javascript-module",
       "path": "dist/Button.js",
-      "declarations": [],
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "### Overview\n\nThe `ui5-ai-button` component represents a button used in AI-related scenarios.\nIt enables users to trigger actions by clicking or tapping the `ui5-ai-button`, or by pressing\ncertain keyboard keys, such as Enter.\n\n### Usage\n\nFor the `ui5-ai-button` UI, you can define one or more states of the button by placing `ai-button-state` components in its default slot.\nEach state have a key that identifies it and can have text, icon, end icon, next state and hasPopup type defined (in any combination) depending on the state purpose.\n\nYou can choose from a set of predefined designs that offer different styling to correspond to the triggered action.\n\nYou can set the `ui5-ai-button` as enabled or disabled. An enabled `ui5-ai-button` can be pressed by clicking or tapping it. On press `ui5-ai-button` changes its state to the next one (if defined).\nthe mouse cursor. A disabled `ui5-ai-button` appears inactive and cannot be pressed.\n\n### ES6 Module Import\n\n`import \"@ui5/webcomponents-ai/dist/Button.js\";`",
+          "name": "Button",
+          "members": [
+            {
+              "kind": "field",
+              "name": "disabled",
+              "type": {
+                "text": "boolean"
+              },
+              "description": "Defines whether the component is disabled.\nA disabled component can't be pressed or\nfocused, and it is not in the tab chain.",
+              "default": "false",
+              "privacy": "public"
+            }
+          ],
+          "attributes": [
+            {
+              "description": "Defines whether the component is disabled.\nA disabled component can't be pressed or\nfocused, and it is not in the tab chain.",
+              "name": "disabled",
+              "default": "false",
+              "fieldName": "disabled",
+              "type": {
+                "text": "boolean"
+              }
+            }
+          ],
+          "superclass": {
+            "name": "UI5Element",
+            "package": "@ui5/webcomponents-base",
+            "module": "dist/UI5Element.js"
+          },
+          "tagName": "ui5-ai-button",
+          "customElement": true
+        }
+      ],
       "exports": [
         {
           "kind": "js",
@@ -20,17 +56,236 @@
             "name": "Button",
             "module": "dist/Button.js"
           }
+        },
+        {
+          "kind": "custom-element-definition",
+          "name": "ui5-ai-button",
+          "declaration": {
+            "name": "Button",
+            "module": "dist/Button.js"
+          }
         }
       ]
     },
     {
       "kind": "javascript-module",
-      "path": "dist/PromtInput.js",
+      "path": "dist/PromptInput.js",
       "declarations": [
         {
           "kind": "class",
-          "description": "",
+          "description": "### Overview\n\nThe `ui5-ai-prompt-input` component allows the user to write custom instructions in natural language, so that AI is guided to generate content tailored to user needs.\n\n**Note:** The web component is in an experimental state\n\n### ES6 Module Import\n\n`import \"@ui5/webcomponents-ai/dist/PromptInput.js",
           "name": "PromptInput",
+          "slots": [
+            {
+              "name": "valueStateMessage",
+              "description": "Defines the value state message that will be displayed as pop up under the component.\nThe value state message slot should contain only one root element.\n\n**Note:** If not specified, a default text (in the respective language) will be displayed.\n\n**Note:** The `valueStateMessage` would be displayed,\nwhen the component is in `Information`, `Critical` or `Negative` value state."
+            }
+          ],
+          "members": [
+            {
+              "kind": "field",
+              "name": "value",
+              "type": {
+                "text": "string"
+              },
+              "description": "Defines the value of the component.",
+              "default": "\"\"",
+              "privacy": "public"
+            },
+            {
+              "kind": "field",
+              "name": "placeholder",
+              "type": {
+                "text": "string"
+              },
+              "description": "Defines a short hint intended to aid the user with data entry when the\ncomponent has no value.",
+              "default": "\"\"",
+              "privacy": "public"
+            },
+            {
+              "kind": "field",
+              "name": "label",
+              "type": {
+                "text": "string"
+              },
+              "description": "Defines the label of the input field.",
+              "default": "\"\"",
+              "privacy": "public"
+            },
+            {
+              "kind": "field",
+              "name": "showClearIcon",
+              "type": {
+                "text": "boolean"
+              },
+              "description": "Defines whether the clear icon of the input will be shown.",
+              "default": "false",
+              "privacy": "public"
+            },
+            {
+              "kind": "field",
+              "name": "showExceededText",
+              "type": {
+                "text": "boolean"
+              },
+              "description": "Determines whether the characters exceeding the maximum allowed character count are visible\nin the component.\n\nIf set to `false`, the user is not allowed to enter more characters than what is set in the\n`maxlength` property.\nIf set to `true` the characters exceeding the `maxlength` value are selected on\npaste and the counter below the component displays their number.",
+              "default": "false",
+              "privacy": "public"
+            },
+            {
+              "kind": "field",
+              "name": "disabled",
+              "type": {
+                "text": "boolean"
+              },
+              "description": "Defines whether the component is in disabled state.\n\n**Note:** A disabled component is completely noninteractive.",
+              "default": "false",
+              "privacy": "public"
+            },
+            {
+              "kind": "field",
+              "name": "readonly",
+              "type": {
+                "text": "boolean"
+              },
+              "description": "Defines whether the component is read-only.\n\n**Note:** A read-only component is not editable,\nbut still provides visual feedback upon user interaction.",
+              "default": "false",
+              "privacy": "public"
+            },
+            {
+              "kind": "field",
+              "name": "maxlength",
+              "type": {
+                "text": "number | undefined"
+              },
+              "description": "Sets the maximum number of characters available in the input field.",
+              "default": "undefined",
+              "privacy": "public"
+            },
+            {
+              "kind": "field",
+              "name": "valueState",
+              "type": {
+                "text": "ValueState",
+                "references": [
+                  {
+                    "name": "ValueState",
+                    "package": "@ui5/webcomponents-base",
+                    "module": "dist/types/ValueState.js"
+                  }
+                ]
+              },
+              "description": "Defines the value state of the component.",
+              "default": "\"None\"",
+              "privacy": "public"
+            }
+          ],
+          "events": [
+            {
+              "name": "submit",
+              "type": {
+                "text": "CustomEvent"
+              },
+              "description": "Fired when the input operation has finished by pressing Enter\nor AI button is clicked."
+            },
+            {
+              "name": "input",
+              "type": {
+                "text": "CustomEvent"
+              },
+              "description": "Fired when the value of the component changes at each keystroke,\nand when a suggestion item has been selected."
+            },
+            {
+              "name": "change",
+              "type": {
+                "text": "CustomEvent"
+              },
+              "description": "Fired when the input operation has finished by pressing Enter\nor on focusout."
+            }
+          ],
+          "attributes": [
+            {
+              "description": "Defines the value of the component.",
+              "name": "value",
+              "default": "\"\"",
+              "fieldName": "value",
+              "type": {
+                "text": "string"
+              }
+            },
+            {
+              "description": "Defines a short hint intended to aid the user with data entry when the\ncomponent has no value.",
+              "name": "placeholder",
+              "default": "\"\"",
+              "fieldName": "placeholder",
+              "type": {
+                "text": "string"
+              }
+            },
+            {
+              "description": "Defines the label of the input field.",
+              "name": "label",
+              "default": "\"\"",
+              "fieldName": "label",
+              "type": {
+                "text": "string"
+              }
+            },
+            {
+              "description": "Defines whether the clear icon of the input will be shown.",
+              "name": "show-clear-icon",
+              "default": "false",
+              "fieldName": "showClearIcon",
+              "type": {
+                "text": "boolean"
+              }
+            },
+            {
+              "description": "Determines whether the characters exceeding the maximum allowed character count are visible\nin the component.\n\nIf set to `false`, the user is not allowed to enter more characters than what is set in the\n`maxlength` property.\nIf set to `true` the characters exceeding the `maxlength` value are selected on\npaste and the counter below the component displays their number.",
+              "name": "show-exceeded-text",
+              "default": "false",
+              "fieldName": "showExceededText",
+              "type": {
+                "text": "boolean"
+              }
+            },
+            {
+              "description": "Defines whether the component is in disabled state.\n\n**Note:** A disabled component is completely noninteractive.",
+              "name": "disabled",
+              "default": "false",
+              "fieldName": "disabled",
+              "type": {
+                "text": "boolean"
+              }
+            },
+            {
+              "description": "Defines whether the component is read-only.\n\n**Note:** A read-only component is not editable,\nbut still provides visual feedback upon user interaction.",
+              "name": "readonly",
+              "default": "false",
+              "fieldName": "readonly",
+              "type": {
+                "text": "boolean"
+              }
+            },
+            {
+              "description": "Sets the maximum number of characters available in the input field.",
+              "name": "maxlength",
+              "default": "undefined",
+              "fieldName": "maxlength",
+              "type": {
+                "text": "number | undefined"
+              }
+            },
+            {
+              "description": "Defines the value state of the component.",
+              "name": "value-state",
+              "default": "\"None\"",
+              "fieldName": "valueState",
+              "type": {
+                "text": "\"None\" | \"Positive\" | \"Critical\" | \"Negative\" | \"Information\""
+              }
+            }
+          ],
           "superclass": {
             "name": "UI5Element",
             "package": "@ui5/webcomponents-base",
@@ -46,7 +301,7 @@
           "name": "default",
           "declaration": {
             "name": "PromptInput",
-            "module": "dist/PromtInput.js"
+            "module": "dist/PromptInput.js"
           }
         },
         {
@@ -54,7 +309,7 @@
           "name": "ui5-ai-prompt-input",
           "declaration": {
             "name": "PromptInput",
-            "module": "dist/PromtInput.js"
+            "module": "dist/PromptInput.js"
           }
         }
       ]

package/dist/generated/i18n/i18n-defaults.d.ts

@@ -1 +1,4 @@
-export {};
+import { I18nText } from "@ui5/webcomponents-base/dist/i18nBundle.js";
+declare const PROMPT_INPUT_CHARACTERS_LEFT: I18nText;
+declare const PROMPT_INPUT_CHARACTERS_EXCEEDED: I18nText;
+export { PROMPT_INPUT_CHARACTERS_LEFT, PROMPT_INPUT_CHARACTERS_EXCEEDED };

package/dist/generated/i18n/i18n-defaults.js

@@ -1,2 +1,5 @@
 import "@ui5/webcomponents-base/dist/i18nBundle.js";
+const PROMPT_INPUT_CHARACTERS_LEFT = { key: "PROMPT_INPUT_CHARACTERS_LEFT", defaultText: "{0} characters remaining" };
+const PROMPT_INPUT_CHARACTERS_EXCEEDED = { key: "PROMPT_INPUT_CHARACTERS_EXCEEDED", defaultText: "{0} characters over limit" };
+export { PROMPT_INPUT_CHARACTERS_LEFT, PROMPT_INPUT_CHARACTERS_EXCEEDED };
 //# sourceMappingURL=i18n-defaults.js.map

package/dist/generated/i18n/i18n-defaults.js.map

@@ -1 +1 @@
-{"version":3,"file":"i18n-defaults.js","sourceRoot":"","sources":["../../../src/generated/i18n/i18n-defaults.ts"],"names":[],"mappings":"AAAA,OAAyB,4CAA4C,CAAC","sourcesContent":["import { I18nText } from \"@ui5/webcomponents-base/dist/i18nBundle.js\";\n\nexport {};"]}
+{"version":3,"file":"i18n-defaults.js","sourceRoot":"","sources":["../../../src/generated/i18n/i18n-defaults.ts"],"names":[],"mappings":"AAAA,OAAyB,4CAA4C,CAAC;AACtE,MAAM,4BAA4B,GAAa,EAAC,GAAG,EAAE,8BAA8B,EAAE,WAAW,EAAE,0BAA0B,EAAC,CAAC;AAAA,MAAM,gCAAgC,GAAa,EAAC,GAAG,EAAE,kCAAkC,EAAE,WAAW,EAAE,2BAA2B,EAAC,CAAC;AACrQ,OAAO,EAAC,4BAA4B,EAAC,gCAAgC,EAAC,CAAC","sourcesContent":["import { I18nText } from \"@ui5/webcomponents-base/dist/i18nBundle.js\";\nconst PROMPT_INPUT_CHARACTERS_LEFT: I18nText = {key: \"PROMPT_INPUT_CHARACTERS_LEFT\", defaultText: \"{0} characters remaining\"};const PROMPT_INPUT_CHARACTERS_EXCEEDED: I18nText = {key: \"PROMPT_INPUT_CHARACTERS_EXCEEDED\", defaultText: \"{0} characters over limit\"};\nexport {PROMPT_INPUT_CHARACTERS_LEFT,PROMPT_INPUT_CHARACTERS_EXCEEDED};"]}

package/dist/generated/templates/PromptInputTemplate.lit.d.ts

@@ -0,0 +1,4 @@
+import type UI5Element from "@ui5/webcomponents-base/dist/UI5Element.js";
+import type PromptInput from "../../PromptInput.js";
+declare function block0(this: PromptInput, context: UI5Element, tags: string[], suffix: string | undefined): import("lit-html").TemplateResult;
+export default block0;