@arcgis/ai-components 5.1.0-next.11 → 5.1.0-next.112

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

@@ -0,0 +1,100 @@
+/* COPYRIGHT Esri - https://js.arcgis.com/5.1/LICENSE.txt */
+import { c } from "../../chunks/runtime.js";
+import { html as p } from "lit";
+import { watch as h } from "@arcgis/core/core/reactiveUtils.js";
+import { LitElement as m } from "@arcgis/lumina";
+import { u as _ } from "../../chunks/useT9n.js";
+import g from "@arcgis/core/core/Accessor.js";
+import { property as u, subclass as f } from "@arcgis/core/core/accessorSupport/decorators.js";
+var y = Object.defineProperty, A = Object.getOwnPropertyDescriptor, d = (e, s, n, i) => {
+  for (var r = i > 1 ? void 0 : i ? A(s, n) : s, t = e.length - 1, a; t >= 0; t--)
+    (a = e[t]) && (r = (i ? a(s, n, r) : a(r)) || r);
+  return i && r && y(s, n, r), r;
+};
+function l() {
+  return typeof window > "u" ? null : window;
+}
+let o = class extends g {
+  constructor() {
+    super(...arguments), this._utterance = null, this.state = "idle", this.supported = o.isSupported();
+  }
+  destroy() {
+    this.stop(), super.destroy();
+  }
+  start(e) {
+    const s = e.trim(), n = l(), i = n?.SpeechSynthesisUtterance, r = n?.speechSynthesis;
+    if (this._set("supported", o.isSupported(n)), !s || !i || !r)
+      return;
+    this.stop();
+    const t = new i(s);
+    t.rate = 0.9, t.pitch = 1.1, t.volume = 1, t.onend = () => {
+      this._utterance === t && this._reset();
+    }, t.onerror = () => {
+      this._utterance === t && this._reset();
+    };
+    try {
+      r.speak(t), this._utterance = t, this._set("state", "playing");
+    } catch {
+      t.onend = null, t.onerror = null, this._reset();
+    }
+  }
+  stop() {
+    const e = l(), s = e?.speechSynthesis;
+    if (this._set("supported", o.isSupported(e)), s)
+      try {
+        (s.speaking || s.pending) && s.cancel();
+      } catch {
+      }
+    this._reset();
+  }
+  toggle(e) {
+    if (this.state === "playing") {
+      this.stop();
+      return;
+    }
+    this.start(e);
+  }
+  static isSupported(e = l()) {
+    return !!e?.speechSynthesis && typeof e.SpeechSynthesisUtterance == "function";
+  }
+  _reset() {
+    this._utterance && (this._utterance.onend = null, this._utterance.onerror = null), this._utterance = null, this._set("state", "idle");
+  }
+};
+d([
+  u({ readOnly: !0 })
+], o.prototype, "state", 2);
+d([
+  u({ readOnly: !0 })
+], o.prototype, "supported", 2);
+o = d([
+  f("ReadAloudController")
+], o);
+class C extends m {
+  constructor() {
+    super(...arguments), this._messages = _({ blocking: !0 }), this._readAloudController = new o(), this.readAloudEnabled = !1;
+  }
+  static {
+    this.properties = { readAloudEnabled: 5, message: 0 };
+  }
+  loaded() {
+    this.manager.onLifecycle(() => [
+      h(() => this._readAloudController.state, () => this.requestUpdate(), { initial: !0 }),
+      {
+        remove: () => {
+          this._readAloudController.stop();
+        }
+      }
+    ]);
+  }
+  _toggleReadAloud() {
+    this._readAloudController.toggle(this.message?.content ?? "");
+  }
+  render() {
+    return this.readAloudEnabled && !this.message?.error && this.message?.content?.trim() && this._readAloudController.supported ? p`<calcite-action id=action-read-aloud .icon=${this._readAloudController.state === "playing" ? "sound-off" : "sound"} scale=s .active=${this._readAloudController.state === "playing"} @click=${() => this._toggleReadAloud()} text></calcite-action><calcite-tooltip reference-element=action-read-aloud overlay-positioning=fixed placement=bottom><span>${this._readAloudController.state === "playing" ? this._messages.stopReadingButtonLabel : this._messages.readAloudButtonLabel}</span></calcite-tooltip>` : null;
+  }
+}
+c("arcgis-assistant-message-read-aloud", C);
+export {
+  C as ArcgisAssistantMessageReadAloud
+};

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

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

package/dist/components/arcgis-assistant-message-read-aloud/index.js

@@ -0,0 +1,3 @@
+import "@esri/calcite-components/components/calcite-action";
+import "@esri/calcite-components/components/calcite-tooltip";
+export * from "./customElement.js";

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

@@ -0,0 +1,7 @@
+/// <reference path="../../index.d.ts" />
+import type { PublicLitElement as LitElement } from "@arcgis/lumina";
+
+/** @internal */
+export abstract class ArcgisAssistantMessageText extends LitElement {
+  accessor content: string | undefined;
+}

package/dist/components/arcgis-assistant-message-text/customElement.js

@@ -0,0 +1,22 @@
+/* COPYRIGHT Esri - https://js.arcgis.com/5.1/LICENSE.txt */
+import { c as t } from "../../chunks/runtime.js";
+import { css as e, html as c } from "lit";
+import { LitElement as a } from "@arcgis/lumina";
+import { unsafeHTML as o } from "lit/directives/unsafe-html.js";
+import { p as r } from "../../chunks/converterUtils.js";
+const i = e`.container{color:var(--calcite-color-text-1)}.content>*{margin:0}.content>*+*{margin-block-start:var(--calcite-spacing-sm)}.content :is(ol,ul){padding-inline-start:var(--calcite-spacing-lg)}.content>calcite-table{display:block;max-width:100%}.content pre{background-color:var(--calcite-color-foreground-1);padding:var(--calcite-spacing-sm);border-radius:var(--calcite-border-radius);color:var(--calcite-color-text-1);direction:ltr;max-width:100%;overflow:auto}.content pre code{display:block;white-space:pre;font-family:var(--calcite-code-family)}`;
+class s extends a {
+  static {
+    this.properties = { content: 1 };
+  }
+  static {
+    this.styles = i;
+  }
+  render() {
+    return c`<div class="container"><div class="content">${o(r(this.content))}</div></div>`;
+  }
+}
+t("arcgis-assistant-message-text", s);
+export {
+  s as ArcgisAssistantMessageText
+};

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

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

package/dist/components/arcgis-assistant-message-text/index.js

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

package/dist/components/arcgis-assistant-navigation-agent/customElement.d.ts

@@ -3,14 +3,14 @@ import type { PublicLitElement as LitElement } from "@arcgis/lumina";
 import type { ArcgisMap as ArcgisMap } from "@arcgis/map-components/components/arcgis-map";
 
 /**
- * The Navigation Agent component enables the end user to navigate to different areas of a web map.
- * It allows you to type in a place name, address, or layer title to navigate to the desired location.
- * Currently, this is only scoped to navigation within a 2D map view.
+ * The Navigation Agent enables the end user to navigate to different areas of a web map. See the list
+ * of capabilities below for more details.
  *
  * This is an unrendered component that must be added as a child of the `arcgis-assistant` component in either HTML or JavaScript.
  *
  * ```html
- * <arcgis-assistant>
+ * <arcgis-map id="my-map"></arcgis-map>
+ * <arcgis-assistant reference-element="my-map">
  *   <arcgis-assistant-navigation-agent></arcgis-assistant-navigation-agent>
  * </arcgis-assistant>
  * ```
@@ -21,14 +21,61 @@ import type { ArcgisMap as ArcgisMap } from "@arcgis/map-components/components/a
  * assistant.appendChild(navigationAgent);
  * ```
  *
+ * Once added to the assistant, the agent is loaded and ready to receive user messages related to navigation.
+ *
+ * ### Capabilities
+ *
+ * The navigation agent provides the following capabilities related to map navigation:
+ *
+ * - **Geocoding** - Navigate to an address using Esri's World Geocoding Service.
+ * - **Go to extent** - Navigate to the extent of a bookmark in the map, the home extent of the web map,
+ *   or the extent of a layer.
+ * - **Go to features** - Navigate to a specified feature or set of features.
+ * - **Go to viewpoint** - Navigate to a specified viewpoint, which can include center, zoom, and/or
+ *   rotation.
+ *
+ * ### Example questions
+ *
+ * The following are example questions a user can ask within the bounds of the navigation agent:
+ *
+ * - "Go to the Golden Gate Bridge"
+ * - "Zoom to a 1 to 24,000 scale"
+ * - "Zoom in"
+ * - "Go to the parks layer"
+ *
+ * The following are examples of the types of questions that fall outside the bounds of the
+ * navigation agent and should therefore be avoided:
+ *
+ * - "Rotate the map 45 degrees" (this capability is not currently supported but may be in the future)
+ * - "Make this map 3D and tilt the view to a 45 degree angle" (3D navigation is currently not supported)
+ * - "Where am I?" (the navigation agent does not have access to the user's location)
+ *
+ * > Due to the non-deterministic nature of generative AI, there may be inaccuracies or unexpected behavior when using the
+ * out-of-the-box agents.
+ *
  * @since 5.0
  * @beta
  * @see [arcgis-assistant](https://developers.arcgis.com/javascript/latest/references/ai-components/components/arcgis-assistant/)
+ * @see [Intro to building agentic mapping applications](https://developers.arcgis.com/javascript/latest/agentic-apps/ai-introduction/)
+ * @see [AI Assistant component sample](https://developers.arcgis.com/javascript/latest/sample-code/ai-assistant/)
  */
 export abstract class ArcgisAssistantNavigationAgent extends LitElement {
   /**
-   * A reference to the map element or its ID string used to resolve the MapView for this agent.
-   * If not provided, the agent will attempt to find the closest parent `arcgis-map` element.
+   * The reference element to the map that provides context for the navigation agent. Currently,
+   * this is only scoped to `arcgis-map` elements. This shows the navigation agent which map on which to
+   * perform navigation actions. This is required for the navigation agent to function properly.
+   *
+   * Setting this property is not necessary if you set the reference element on the parent
+   * `arcgis-assistant` component.
+   *
+   * @see [arcgis-assistant.referenceElement](https://developers.arcgis.com/javascript/latest/references/ai-components/components/arcgis-assistant/#referenceElement)
+   * @example
+   * ```html
+   * <arcgis-map id="my-map"></arcgis-map>
+   * <arcgis-assistant>
+   *   <arcgis-assistant-navigation-agent reference-element="my-map"></arcgis-assistant-navigation-agent>
+   * </arcgis-assistant>
+   * ```
    */
   accessor referenceElement: ArcgisMap | string | undefined;
 }

package/dist/components/arcgis-assistant-navigation-agent/customElement.js

@@ -2,7 +2,7 @@
 import { c as t } from "../../chunks/runtime.js";
 import { LitElement as i } from "@arcgis/lumina";
 import { NavigationAgent as s } from "@arcgis/ai-agents";
-import { r as a, i as e } from "../../chunks/utils.js";
+import { r as a, a as e } from "../../chunks/utils.js";
 class n extends i {
   constructor() {
     super(...arguments), this.agent = s;

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

@@ -0,0 +1,31 @@
+/// <reference path="../../index.d.ts" />
+import type { PublicLitElement as LitElement } from "@arcgis/lumina";
+import type { VoiceInputDraftChangeDetail, VoiceInputErrorCode, VoiceInputMode, VoiceInputTranscriptDetail, VoiceInputTranscriptionStreamChunkDetail } from "./support/types.js";
+
+/** @internal */
+export abstract class ArcgisAssistantSpeechInput extends LitElement {
+  /** @default false */
+  accessor awaitingResponse: boolean;
+  /** @default "" */
+  accessor inputValue: string;
+  accessor language: string | undefined;
+  /** @default "web-speech" */
+  accessor mode: VoiceInputMode;
+  clearDraftSession(): void;
+  readonly arcgisVoiceInputDraftChange: import("@arcgis/lumina").TargetedEvent<this, VoiceInputDraftChangeDetail>;
+  readonly arcgisVoiceInputError: import("@arcgis/lumina").TargetedEvent<this, { errorCode: VoiceInputErrorCode; }>;
+  readonly arcgisVoiceInputInterimTranscription: import("@arcgis/lumina").TargetedEvent<this, VoiceInputTranscriptDetail>;
+  readonly arcgisVoiceInputStart: import("@arcgis/lumina").TargetedEvent<this, void>;
+  readonly arcgisVoiceInputStop: import("@arcgis/lumina").TargetedEvent<this, void>;
+  readonly arcgisVoiceInputTranscription: import("@arcgis/lumina").TargetedEvent<this, VoiceInputTranscriptDetail>;
+  readonly arcgisVoiceInputTranscriptionStreamChunk: import("@arcgis/lumina").TargetedEvent<this, VoiceInputTranscriptionStreamChunkDetail>;
+  readonly "@eventTypes": {
+    arcgisVoiceInputDraftChange: ArcgisAssistantSpeechInput["arcgisVoiceInputDraftChange"]["detail"];
+    arcgisVoiceInputError: ArcgisAssistantSpeechInput["arcgisVoiceInputError"]["detail"];
+    arcgisVoiceInputInterimTranscription: ArcgisAssistantSpeechInput["arcgisVoiceInputInterimTranscription"]["detail"];
+    arcgisVoiceInputStart: ArcgisAssistantSpeechInput["arcgisVoiceInputStart"]["detail"];
+    arcgisVoiceInputStop: ArcgisAssistantSpeechInput["arcgisVoiceInputStop"]["detail"];
+    arcgisVoiceInputTranscription: ArcgisAssistantSpeechInput["arcgisVoiceInputTranscription"]["detail"];
+    arcgisVoiceInputTranscriptionStreamChunk: ArcgisAssistantSpeechInput["arcgisVoiceInputTranscriptionStreamChunk"]["detail"];
+  };
+}