@arcgis/ai-components 5.2.0-next.4 → 5.2.0-next.6

package/dist/components/arcgis-assistant-chat/customElement.d.ts

@@ -3,7 +3,12 @@ import type Collection from "@arcgis/core/core/Collection.js";
 import type { PublicLitElement as LitElement } from "@arcgis/lumina";
 import type { ChatMessage } from "../arcgis-assistant/types.js";
 
-/** @internal */
+/**
+ * Wraps and renders the conversation area. Use it as the container for message list content.
+ * Offers chat-level layout structure for message starter, message list, and loading regions.
+ *
+ * @internal
+ */
 export abstract class ArcgisAssistantChat extends LitElement {
   /** @default false */
   accessor loading: boolean;

package/dist/components/arcgis-assistant-chat-entry/customElement.d.ts

@@ -5,7 +5,8 @@ import type { ChatMessage } from "../arcgis-assistant/types.js";
 import type { T9nMeta } from "@arcgis/lumina/controllers";
 
 /**
- * An input bar primitive for collecting assistant prompts.
+ * Provides the input bar and submit or cancel behavior. Use it to collect prompts and emit submit events.
+ * Offers keyboard submit/history behavior, entry action slots, and optional voice-input integration.
  *
  * @slot [entry-actions-start] - Slot for adding actions to the start of the entry area.
  * @slot [entry-actions-end] - Slot for adding actions to the end of the entry area.

package/dist/components/arcgis-assistant-interrupt/customElement.d.ts

@@ -2,7 +2,10 @@
 import type { PublicLitElement as LitElement } from "@arcgis/lumina";
 import type { T9nMeta } from "@arcgis/lumina/controllers";
 
-/** @internal */
+/**
+ * Renders interrupt prompts for extra user input. Use it when an agent pauses for confirmation, choice, or text input.
+ * Offers interrupt-specific input modes and submit or cancel event handling.
+ */
 export abstract class ArcgisAssistantInterrupt extends LitElement {
   /** @internal */
   protected _messages: {

package/dist/components/arcgis-assistant-message/customElement.d.ts

@@ -0,0 +1,21 @@
+/// <reference path="../../index.d.ts" />
+import type { PublicLitElement as LitElement } from "@arcgis/lumina";
+import type { AssistantMessage } from "../arcgis-assistant/types.js";
+
+/**
+ * Renders a single assistant response message shell. Pass one assistant message object and let it host body and footer actions.
+ * Offers a reusable assistant-message layout with icon, content, and footer slot regions.
+ */
+export abstract class ArcgisAssistantMessage extends LitElement {
+  /** @default false */
+  accessor copyEnabled: boolean;
+  /** @default false */
+  accessor feedbackEnabled: boolean;
+  /** @default false */
+  accessor footerDisabled: boolean;
+  /** @default false */
+  accessor logEnabled: boolean;
+  accessor message: AssistantMessage | undefined;
+  /** @default false */
+  accessor readAloudEnabled: boolean;
+}

package/dist/components/arcgis-assistant-message/index.d.ts

@@ -0,0 +1 @@
+export * from "./customElement.js";

package/dist/components/arcgis-assistant-message-block/customElement.d.ts

@@ -2,7 +2,7 @@
 import type { PublicLitElement as LitElement } from "@arcgis/lumina";
 import type { UXSuggestion } from "../../utils/index.js";
 
-/** A primitive for rendering a default assistant output block. */
+/** Renders one structured assistant block. Offers default block rendering for supported suggestion-style blocks. */
 export abstract class ArcgisAssistantMessageBlock extends LitElement {
   accessor block: UXSuggestion | undefined;
 }

package/dist/components/arcgis-assistant-message-feedback/customElement.d.ts

@@ -3,7 +3,10 @@ import type { PublicLitElement as LitElement } from "@arcgis/lumina";
 import type { AssistantMessage } from "../arcgis-assistant/types.js";
 import type { T9nMeta } from "@arcgis/lumina/controllers";
 
-/** @internal */
+/**
+ * Handles thumbs up or down feedback UI. Use it to capture helpful or not helpful signals per response.
+ * Offers feedback toggle behavior and emits feedback updates for the associated assistant message.
+ */
 export abstract class ArcgisAssistantMessageFeedback extends LitElement {
   /** @internal */
   protected _messages: {

package/dist/components/arcgis-assistant-message-footer/customElement.d.ts

@@ -3,7 +3,10 @@ import type { PublicLitElement as LitElement } from "@arcgis/lumina";
 import type { AssistantMessage } from "../arcgis-assistant/types.js";
 import type { T9nMeta } from "@arcgis/lumina/controllers";
 
-/** @internal */
+/**
+ * Renders the action row under an assistant message. Use it when you want feedback, log, copy, or read-aloud controls.
+ * Offers one footer surface that composes common assistant response actions.
+ */
 export abstract class ArcgisAssistantMessageFooter extends LitElement {
   /** @internal */
   protected _messages: {

package/dist/components/arcgis-assistant-message-loading/customElement.d.ts

@@ -1,7 +1,10 @@
 /// <reference path="../../index.d.ts" />
 import type { PublicLitElement as LitElement } from "@arcgis/lumina";
 
-/** @internal */
+/**
+ * Shows in-progress assistant response UI. Use it to display thinking or loading state while work is running.
+ * Offers a default loading message shell with icon/content slot overrides.
+ */
 export abstract class ArcgisAssistantMessageLoading extends LitElement {
   /** @default false */
   accessor loading: boolean;

package/dist/components/arcgis-assistant-message-log/customElement.d.ts

@@ -1,7 +1,10 @@
 /// <reference path="../../index.d.ts" />
 import type { PublicLitElement as LitElement } from "@arcgis/lumina";
 
-/** @internal */
+/**
+ * Renders expandable execution log details. Use it when exposing agent or tool trace output.
+ * Offers collapsible log entry rendering for debugging and troubleshooting.
+ */
 export abstract class ArcgisAssistantMessageLog extends LitElement {
   accessor log: string[] | undefined;
   /** @default false */

package/dist/components/arcgis-assistant-message-read-aloud/customElement.d.ts

@@ -3,7 +3,10 @@ import type { PublicLitElement as LitElement } from "@arcgis/lumina";
 import type { AssistantMessage } from "../arcgis-assistant/types.js";
 import type { T9nMeta } from "@arcgis/lumina/controllers";
 
-/** @internal */
+/**
+ * Adds text-to-speech playback controls. Use it to read assistant responses aloud.
+ * Offers read-aloud start/stop behavior with supported-state handling.
+ */
 export abstract class ArcgisAssistantMessageReadAloud extends LitElement {
   /** @internal */
   protected _messages: {

package/dist/components/arcgis-assistant-message-text/customElement.d.ts

@@ -1,7 +1,10 @@
 /// <reference path="../../index.d.ts" />
 import type { PublicLitElement as LitElement } from "@arcgis/lumina";
 
-/** @internal */
+/**
+ * Renders assistant message text content. Use it when the block is plain text output.
+ * Offers sanitized rich-text rendering for assistant-generated message content.
+ */
 export abstract class ArcgisAssistantMessageText extends LitElement {
   accessor content: string | undefined;
 }

package/dist/components/arcgis-assistant-speech-input/customElement.d.ts

@@ -2,7 +2,12 @@
 import type { PublicLitElement as LitElement } from "@arcgis/lumina";
 import type { VoiceInputDraftChangeDetail, VoiceInputErrorCode, VoiceInputMode, VoiceInputTranscriptDetail, VoiceInputTranscriptionStreamChunkDetail } from "./support/types.js";
 
-/** @internal */
+/**
+ * Captures voice input and drafts transcript text. Use it to support microphone-based prompt entry.
+ * Offers voice session lifecycle management and transcription event streams.
+ *
+ * @internal
+ */
 export abstract class ArcgisAssistantSpeechInput extends LitElement {
   /** @default false */
   accessor awaitingResponse: boolean;

package/dist/components/arcgis-assistant-suggested-prompts/customElement.d.ts

@@ -3,7 +3,10 @@ import type { PublicLitElement as LitElement } from "@arcgis/lumina";
 import type { AssistantPromptSelectDetail } from "../arcgis-assistant/types.js";
 import type { T9nMeta } from "@arcgis/lumina/controllers";
 
-/** A prompt chip list primitive for rendering assistant suggested prompts. */
+/**
+ * Displays prompt chips and emits selection events. Use it to offer quick starter prompts.
+ * Offers selectable prompt chips with a prompt-select event for host synchronization.
+ */
 export abstract class ArcgisAssistantSuggestedPrompts extends LitElement {
   /** @internal */
   protected _messages: { suggestedPromptsLabel: string; } & T9nMeta<{ suggestedPromptsLabel: string; }>;

package/dist/components/arcgis-assistant-user-message/customElement.d.ts

@@ -2,7 +2,10 @@
 import type { PublicLitElement as LitElement } from "@arcgis/lumina";
 import type { ChatMessage } from "../arcgis-assistant/types.js";
 
-/** @internal */
+/**
+ * Renders one user-authored chat message row. Use it for displaying what the user sent.
+ * Offers a simple user message presentation primitive for custom message-list rendering.
+ */
 export abstract class ArcgisAssistantUserMessage extends LitElement {
   accessor content: string | undefined;
   accessor message: ChatMessage | undefined;