@arcgis/ai-components 5.0.0-next.151 → 5.0.0-next.152

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -42,8 +42,8 @@ import type { ArcgisMap as ArcgisMap } from "@arcgis/map-components/components/a
42
42
  * @slot [footer-content] - Slot for adding content to the footer.
43
43
  * @since 5.0
44
44
  * @beta
45
- * @see [arcgis-assistant-data-exploration-agent](https://developers.arcgis.com/javascript/latest/references/ai-components/arcgis-assistant-data-exploration-agent/)
46
- * @see [arcgis-assistant-navigation-agent](https://developers.arcgis.com/javascript/latest/references/ai-components/arcgis-assistant-navigation-agent/)
45
+ * @see [arcgis-assistant-data-exploration-agent](https://developers.arcgis.com/javascript/latest/references/ai-components/components/arcgis-assistant-data-exploration-agent/)
46
+ * @see [arcgis-assistant-navigation-agent](https://developers.arcgis.com/javascript/latest/references/ai-components/components/arcgis-assistant-navigation-agent/)
47
47
  */
48
48
  export abstract class ArcgisAssistant extends LitElement {
49
49
  /** @internal */
@@ -40,7 +40,7 @@ import type { PublicLitElement as LitElement } from "@arcgis/lumina";
40
40
  *
41
41
  * @since 5.0
42
42
  * @beta
43
- * @see [arcgis-assistant](https://developers.arcgis.com/javascript/latest/references/ai-components/arcgis-assistant/)
43
+ * @see [arcgis-assistant](https://developers.arcgis.com/javascript/latest/references/ai-components/components/arcgis-assistant/)
44
44
  * @see [LangGraph documentation](https://docs.langchain.com/oss/javascript/langgraph/overview)
45
45
  */
46
46
  export abstract class ArcgisAssistantAgent<TContext = Record<string, unknown>> extends LitElement {
@@ -23,7 +23,7 @@ import type { ArcgisMap as ArcgisMap } from "@arcgis/map-components/components/a
23
23
  *
24
24
  * @since 5.0
25
25
  * @beta
26
- * @see [arcgis-assistant](https://developers.arcgis.com/javascript/latest/references/ai-components/arcgis-assistant/)
26
+ * @see [arcgis-assistant](https://developers.arcgis.com/javascript/latest/references/ai-components/components/arcgis-assistant/)
27
27
  */
28
28
  export abstract class ArcgisAssistantDataExplorationAgent extends LitElement {
29
29
  /**
@@ -23,7 +23,7 @@ import type { ArcgisMap as ArcgisMap } from "@arcgis/map-components/components/a
23
23
  *
24
24
  * @since 5.0
25
25
  * @beta
26
- * @see [arcgis-assistant](https://developers.arcgis.com/javascript/latest/references/ai-components/arcgis-assistant/)
26
+ * @see [arcgis-assistant](https://developers.arcgis.com/javascript/latest/references/ai-components/components/arcgis-assistant/)
27
27
  */
28
28
  export abstract class ArcgisAssistantNavigationAgent extends LitElement {
29
29
  /**
@@ -1 +1 @@
1
- {"timestamp":"2026-01-29T04:55:54","compiler":{"name":"@arcgis/lumina-compiler","version":"5.0.0-next.151","typescriptVersion":"5.9.3"},"schemaVersion":"2.1.0","modules":[{"kind":"javascript-module","path":"index","sourcePath":"src/index.ts","declarations":[{"kind":"function","name":"getAssetPath","description":"Get a resolved path from where an asset can be loaded.","parameters":[{"name":"suffix","description":"The relative path for the asset.","type":{"text":"string"}}],"return":{"type":{"text":"string"}}},{"kind":"function","name":"setAssetPath","description":"Used to manually set the base path where package assets (like localization\nand icons) can be found.\n\nBy default, the package assets are loaded from\n`https://js.arcgis.com/<version>/<simplified-package-name>/`. We are hosting\nour assets on a CDN (Content Delivery Network) to ensure fast and reliable\naccess. It is CORS-enabled, so you can load the assets from any domain. This\nis the recommended way to load the assets and avoid bundling them with your\napplication.\n\nHowever, if you need to host the assets locally, you can copy them manually\nas part of your build process and use `setAssetPath` to customize where the\nbrowser will load the assets from.","parameters":[{"name":"path","description":"Relative or absolute path to the assets folder.","type":{"text":"URL | string","references":[{"name":"URL","package":"global:","viewUrl":"https://developer.mozilla.org/docs/Web/API/URL","start":0,"end":3}]}}],"return":{"type":{"text":"void"}}}]},{"kind":"javascript-module","path":"components/arcgis-assistant","sourcePath":"src/components/assistant/assistant.tsx","declarations":[{"kind":"class","name":"ArcgisAssistant","customElement":true,"tagName":"arcgis-assistant","pascalCaseName":"ArcgisAssistant","description":"The ArcGIS Assistant component provides a chat-based natural language interface for interacting with\nmap data and services. This component relies on large language models to understand user prompts and\ngenerate both text and structured responses based on the user's intent and the context of the map.\n\nBy default, the `arcgis-assistant` component does not include any agents. You must register at least one\nagent for the assistant to function. You can register agents declaratively using any of the\navailable agent components, or you can register custom agents.\n\n## Register ArcGIS agents\n\nTo register ArcGIS agents declaratively, include one or more of the following agent components as children\nof the `arcgis-assistant` component. This can be done in HTML or programmatically using JavaScript.\n\n```html\n<arcgis-assistant>\n <arcgis-assistant-navigation-agent></arcgis-assistant-navigation-agent>\n <arcgis-assistant-data-exploration-agent></arcgis-assistant-data-exploration-agent>\n</arcgis-assistant>\n```\n\n```js\nconst assistant = document.querySelector(\"arcgis-assistant\");\nconst navigationAgent = document.createElement(\"arcgis-assistant-navigation-agent\");\nconst dataExplorationAgent = document.createElement(\"arcgis-assistant-data-exploration-agent\");\nassistant.appendChild(navigationAgent);\nassistant.appendChild(dataExplorationAgent);\n```\n\nTo learn more about this component, try out the [demo](#demo) below.","docsTags":[{"name":"since","text":"5.0"},{"name":"beta"},{"name":"see","text":"[arcgis-assistant-data-exploration-agent](https://developers.arcgis.com/javascript/latest/references/ai-components/arcgis-assistant-data-exploration-agent/)"},{"name":"see","text":"[arcgis-assistant-navigation-agent](https://developers.arcgis.com/javascript/latest/references/ai-components/arcgis-assistant-navigation-agent/)"}],"demos":[{"description":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/ai-components/arcgis-assistant/"},{"description":"Assistant Intro\nIntroduction to the Assistant component.","url":"https://developers.arcgis.com/javascript/latest/storybook/ai-components/?path=/story/arcgis-assistant--demo&singleStory=true"}],"superclass":{"name":"PublicLitElement","module":"PublicLitElement","package":"@arcgis/lumina"},"members":[{"kind":"field","name":"description","description":"The description text displayed below the heading in the assistant. This text provides additional\ncontext about the assistant's capabilities and how users can interact with it.","docsTags":[{"name":"example","text":"```html\n<arcgis-assistant description=\"Ask anything about your map data.\"></arcgis-assistant>\n```"},{"name":"example","text":"```js\nconst assistant = document.querySelector(\"arcgis-assistant\");\nassistant.description = \"Ask anything about your map data.\";\n```"}],"type":{"text":"string | undefined","values":[{"type":"string"}]},"attribute":"description"},{"kind":"field","name":"entryMessage","description":"The message to display when the assistant is first loaded.","docsTags":[{"name":"example","text":"```html\n<arcgis-assistant entry-message=\"Hello! How can I assist you with your map today?\"></arcgis-assistant>\n```"},{"name":"example","text":"```js\nconst assistant = document.querySelector(\"arcgis-assistant\");\nassistant.entryMessage = \"Hello! How can I assist you with your map today?\";\n```"}],"type":{"text":"string | undefined","values":[{"type":"string"}]},"attribute":"entry-message"},{"kind":"field","name":"heading","description":"The heading text displayed at the top of the assistant. This name should be concise and\ndescriptive of the assistant's purpose.","docsTags":[{"name":"example","text":"```html\n<arcgis-assistant heading=\"Map Assistant\"></arcgis-assistant>\n```"},{"name":"example","text":"```js\nconst assistant = document.querySelector(\"arcgis-assistant\");\nassistant.heading = \"Map Assistant\";\n```"}],"type":{"text":"string | undefined","values":[{"type":"string"}]},"attribute":"heading"},{"kind":"field","name":"portal","description":"The portal used for authentication and making requests to the LLM via proxy requests.","docsTags":[{"name":"example","text":"```js\nconst assistant = document.querySelector(\"arcgis-assistant\");\nassistant.portal = new Portal({ url: \"https://www.arcgis.com\" });\n```"}],"type":{"text":"Portal","references":[{"name":"default","module":"portal/Portal.js","package":"@arcgis/core","viewUrl":"https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html","start":0,"end":6}]}},{"kind":"field","name":"referenceElement","description":"The reference element to the map that provides context for the assistant and its agents. Currently,\nthis is only scoped to `arcgis-map` elements, but may be extended to support other elements in\nthe future.","docsTags":[{"name":"example","text":"```html\n<arcgis-map id=\"my-map\"></arcgis-map>\n<arcgis-assistant reference-element=\"#my-map\"></arcgis-assistant>\n```"}],"type":{"text":"ArcgisMap | string | null","references":[{"name":"ArcgisMap","module":"components/arcgis-map","package":"@arcgis/map-components","start":0,"end":9}],"values":[{"type":"string"},{"type":"object"}]},"attribute":"reference-element"},{"kind":"field","name":"suggestedPrompts","description":"Suggested prompts to display in the assistant on load. These are intended to help users get started\nwith common queries or actions.You should typically provide 2-3 suggested prompts that are\nrelevant to the context of the data being used and the capabilities of the registered agents.","docsTags":[{"name":"example","text":"```js\nconst assistant = document.querySelector(\"arcgis-assistant\");\nassistant.suggestedPrompts = [\n \"What city has the highest population?\",\n \"What is the highest point in this area?\"\n];\n```"}],"type":{"text":"string[]"}},{"kind":"method","name":"componentOnReady","description":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisAssistant = document.querySelector(\"arcgis-assistant\");\ndocument.body.append(arcgisAssistant);\nawait arcgisAssistant.componentOnReady();\nconsole.log(\"arcgis-assistant is ready to go!\");\n```"}],"return":{"type":{"text":"Promise<this>","references":[{"name":"Promise","module":"lib/lib.es5.d.ts","package":"typescript","start":0,"end":7}]}},"inheritedFrom":{"name":"PublicLitElement","module":"PublicLitElement","package":"@arcgis/lumina"},"signature":"(): Promise<this>"}],"attributes":[{"name":"description","description":"The description text displayed below the heading in the assistant. This text provides additional\ncontext about the assistant's capabilities and how users can interact with it.","type":{"text":"string","values":[{"type":"string"}]},"fieldName":"description"},{"name":"entry-message","description":"The message to display when the assistant is first loaded.","type":{"text":"string","values":[{"type":"string"}]},"fieldName":"entryMessage"},{"name":"heading","description":"The heading text displayed at the top of the assistant. This name should be concise and\ndescriptive of the assistant's purpose.","type":{"text":"string","values":[{"type":"string"}]},"fieldName":"heading"},{"name":"reference-element","description":"The reference element to the map that provides context for the assistant and its agents. Currently,\nthis is only scoped to `arcgis-map` elements, but may be extended to support other elements in\nthe future.","type":{"text":"string","values":[{"type":"string"}]},"fieldName":"referenceElement"}],"slots":[{"name":"","description":"This is the default slot"},{"name":"header-actions-end","description":"Slot for adding actions to the end of the header."},{"name":"entry-message","description":"Slot for adding a welcome or entry message on load."},{"name":"entry-actions-start","description":"Slot for adding actions to the start of the entry area."},{"name":"footer-content","description":"Slot for adding content to the footer."}],"importPath":"components/arcgis-assistant"}],"exports":[{"kind":"custom-element-definition","name":"arcgis-assistant","declaration":{"name":"ArcgisAssistant"}}]},{"kind":"javascript-module","path":"components/arcgis-assistant-agent","sourcePath":"src/components/assistant/assistant-agents/assistant-agent/assistant-agent.tsx","declarations":[{"kind":"class","name":"ArcgisAssistantAgent","customElement":true,"tagName":"arcgis-assistant-agent","pascalCaseName":"ArcgisAssistantAgent","description":"The Assistant Agent component is a generic wrapper for adding custom AI agents into the ArcGIS Assistant component. To define\na custom agent, you must be familiar with [LangGraph](https://docs.langchain.com/oss/javascript/langgraph/overview). Custom agents must\ninclude a StateGraph that defines the agent's graph and subgraphs.\n\n> Building custom agents can only be done using modern JavaScript/TypeScript tooling and cannot be done directly in HTML using\nCDN imports. Therefore, you must use a package manager like npm or yarn to install the required dependencies. Please refer to the\nCreating Custom Agents guide for more instructions.\n\nThis is an unrendered component that must be added as a child of the `arcgis-assistant` component in either HTML or JavaScript.\n\n```html\n<arcgis-assistant></arcgis-assistant>\n```\n\n```js\nconst myCustomAgent = {\n id: \"my-custom-agent\",\n name: \"My Custom Agent\",\n description: \"An agent that does custom things. Use this agent when users want to do custom things.\",\n createGraph: {\n // StateGraph definition using LangGraph\n },\n workspace: {\n // AnnotationRoot definition using LangGraph\n // relevant variables and context required by the agent\n },\n};\n\nconst assistant = document.querySelector(\"arcgis-assistant\");\nconst assistantAgent = document.createElement(\"arcgis-assistant-agent\");\n\nassistantAgent.agent = myCustomAgent;\nassistant.appendChild(assistantAgent);\n```","docsTags":[{"name":"since","text":"5.0"},{"name":"beta"},{"name":"see","text":"[arcgis-assistant](https://developers.arcgis.com/javascript/latest/references/ai-components/arcgis-assistant/)"},{"name":"see","text":"[LangGraph documentation](https://docs.langchain.com/oss/javascript/langgraph/overview)"}],"demos":[{"description":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/ai-components/arcgis-assistant-agent/"},{"description":"Custom Agent","url":"https://developers.arcgis.com/javascript/latest/storybook/ai-components/?path=/story/arcgis-assistant-agent--demo&singleStory=true"}],"typeParameters":[{"name":"TContext","default":{"text":"Record<string, unknown>","references":[{"name":"Record","package":"global:","viewUrl":"https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type","start":0,"end":6}]}}],"superclass":{"name":"PublicLitElement","module":"PublicLitElement","package":"@arcgis/lumina"},"members":[{"kind":"field","name":"agent","description":"The agent registration object that defines the AI agent's behavior and capabilities.\nThis must include a StateGraph definition (defined using\n[LangGraph](https://docs.langchain.com/oss/javascript/langgraph/overview)).\n\nThis is an agent defined in the client and can be invoked by the assistant within the browser to perform specific tasks\nusing functions defined in the client.\n\nSee the Creating Custom Agents guide for more instructions.","docsTags":[{"name":"required"},{"name":"see","text":"[LangGraph documentation](https://docs.langchain.com/oss/javascript/langgraph/overview)"},{"name":"example","text":"```js\n// An example graph that updates a component property and replies with a confirmation message\nconst myCustomGraph = () => {\n const graph = new StateGraph(myCustomState)\n .addNode(\"updateComponentProperty\", updateComponentProperty)\n .addNode(\"replyComponentPropertyUpdate\", replyComponentPropertyUpdate)\n .addEdge(START, \"updateComponentProperty\")\n .addEdge(\"updateComponentProperty\", \"replyComponentPropertyUpdate\")\n .addEdge(\"replyComponentPropertyUpdate\", END);\n\n return graph;\n};\n\nconst myCustomAgentState = Annotation.Root({\n // This is required to keep track of chat messages between the user and the agent\n messages: Annotation<ChatHistory>({\n reducer: messagesStateReducer,\n default: () => [],\n }),\n // Accumulates user-visible output across graph nodes\n outputMessage: Annotation<string>({\n reducer: (current = \"\", update) =>\n typeof update === \"string\" && update.trim()\n ? current\n ? `${current}\\n\\n${update}`\n : update\n : current,\n default: () => \"\",\n }),\n // Result of the UI action performed by the agent\n // This is a custom type defined by the application\n result: Annotation<UIActionResult | null>({\n reducer: (_current, update) => update ?? null,\n default: () => null,\n }),\n});\n\nconst myCustomAgent = {\n id: \"my-custom-agent\",\n name: \"My Custom Agent\",\n description: \"An agent that does custom things. Use this agent when users want to do custom things.\",\n createGraph: myCustomGraph,\n workspace: myCustomAgentState,\n};\n\nconst assistant = document.querySelector(\"arcgis-assistant\");\nconst assistantAgent = document.createElement(\"arcgis-assistant-agent\");\n\nassistantAgent.agent = myCustomAgent;\nassistant.appendChild(assistantAgent);\n```"}],"type":{"text":"AgentRegistration","references":[{"name":"AgentRegistration","package":"@arcgis/ai-orchestrator","start":0,"end":17}]}},{"kind":"field","name":"context","description":"If the agent requires context, it can be provided via this property and accessed in the\nagent's graph nodes.","docsTags":[{"name":"example","text":"```js\nassistantAgent.context = {\n myData: {\n // custom context data for the agent\n },\n};\n```"}],"type":{"text":"TContext | undefined","references":[{"name":"TContext","start":0,"end":8}]}},{"kind":"method","name":"componentOnReady","description":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisAssistantAgent = document.querySelector(\"arcgis-assistant-agent\");\ndocument.body.append(arcgisAssistantAgent);\nawait arcgisAssistantAgent.componentOnReady();\nconsole.log(\"arcgis-assistant-agent is ready to go!\");\n```"}],"return":{"type":{"text":"Promise<this>","references":[{"name":"Promise","module":"lib/lib.es5.d.ts","package":"typescript","start":0,"end":7}]}},"inheritedFrom":{"name":"PublicLitElement","module":"PublicLitElement","package":"@arcgis/lumina"},"signature":"(): Promise<this>"}],"importPath":"components/arcgis-assistant-agent"}],"exports":[{"kind":"custom-element-definition","name":"arcgis-assistant-agent","declaration":{"name":"ArcgisAssistantAgent"}}]},{"kind":"javascript-module","path":"components/arcgis-assistant-data-exploration-agent","sourcePath":"src/components/assistant/assistant-agents/assistant-data-exploration-agent/assistant-data-exploration-agent.tsx","declarations":[{"kind":"class","name":"ArcgisAssistantDataExplorationAgent","customElement":true,"tagName":"arcgis-assistant-data-exploration-agent","pascalCaseName":"ArcgisAssistantDataExplorationAgent","description":"The Data Exploration Agent component enables the end user to query features, statistics, and spatial proximity\nof layer within a provided web map. Currently, this is only scoped to querying feature layers within\na 2D web map.\n\nThis is an unrendered component that must be added as a child of the `arcgis-assistant` component in either HTML or JavaScript.\n\n```html\n<arcgis-assistant>\n <arcgis-assistant-data-exploration-agent></arcgis-assistant-data-exploration-agent>\n</arcgis-assistant>\n```\n\n```js\nconst assistant = document.querySelector(\"arcgis-assistant\");\nconst dataExplorationAgent = document.createElement(\"arcgis-assistant-data-exploration-agent\");\nassistant.appendChild(dataExplorationAgent);\n```","docsTags":[{"name":"since","text":"5.0"},{"name":"beta"},{"name":"see","text":"[arcgis-assistant](https://developers.arcgis.com/javascript/latest/references/ai-components/arcgis-assistant/)"}],"demos":[{"description":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/ai-components/arcgis-assistant-data-exploration-agent/"},{"description":"Data Exploration Agent","url":"https://developers.arcgis.com/javascript/latest/storybook/ai-components/?path=/story/arcgis-assistant-data-exploration-agent--demo&singleStory=true"}],"superclass":{"name":"PublicLitElement","module":"PublicLitElement","package":"@arcgis/lumina"},"members":[{"kind":"field","name":"referenceElement","description":"A reference to the map element or its ID string used to resolve the MapView for this agent.\nIf not provided, the agent will attempt to find the closest parent `arcgis-map` element.","type":{"text":"ArcgisMap | string | undefined","references":[{"name":"ArcgisMap","module":"components/arcgis-map","package":"@arcgis/map-components","start":0,"end":9}],"values":[{"type":"string"},{"type":"object"}]},"attribute":"reference-element"},{"kind":"method","name":"componentOnReady","description":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisAssistantDataExplorationAgent = document.querySelector(\"arcgis-assistant-data-exploration-agent\");\ndocument.body.append(arcgisAssistantDataExplorationAgent);\nawait arcgisAssistantDataExplorationAgent.componentOnReady();\nconsole.log(\"arcgis-assistant-data-exploration-agent is ready to go!\");\n```"}],"return":{"type":{"text":"Promise<this>","references":[{"name":"Promise","module":"lib/lib.es5.d.ts","package":"typescript","start":0,"end":7}]}},"inheritedFrom":{"name":"PublicLitElement","module":"PublicLitElement","package":"@arcgis/lumina"},"signature":"(): Promise<this>"}],"attributes":[{"name":"reference-element","description":"A reference to the map element or its ID string used to resolve the MapView for this agent.\nIf not provided, the agent will attempt to find the closest parent `arcgis-map` element.","type":{"text":"string","values":[{"type":"string"}]},"fieldName":"referenceElement"}],"importPath":"components/arcgis-assistant-data-exploration-agent"}],"exports":[{"kind":"custom-element-definition","name":"arcgis-assistant-data-exploration-agent","declaration":{"name":"ArcgisAssistantDataExplorationAgent"}}]},{"kind":"javascript-module","path":"components/arcgis-assistant-layer-filter-agent","sourcePath":"src/components/assistant/assistant-agents/assistant-layer-filter-agent/assistant-layer-filter-agent.tsx","declarations":[{"kind":"class","name":"ArcgisAssistantLayerFilterAgent","customElement":true,"tagName":"arcgis-assistant-layer-filter-agent","pascalCaseName":"ArcgisAssistantLayerFilterAgent","docsTags":[{"name":"internal"}],"demos":[{"description":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/ai-components/arcgis-assistant-layer-filter-agent/"}],"superclass":{"name":"PublicLitElement","module":"PublicLitElement","package":"@arcgis/lumina"},"members":[{"kind":"field","name":"referenceElement","type":{"text":"ArcgisMap | string | undefined","references":[{"name":"ArcgisMap","module":"components/arcgis-map","package":"@arcgis/map-components","start":0,"end":9}],"values":[{"type":"string"},{"type":"object"}]},"attribute":"reference-element"},{"kind":"method","name":"componentOnReady","description":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisAssistantLayerFilterAgent = document.querySelector(\"arcgis-assistant-layer-filter-agent\");\ndocument.body.append(arcgisAssistantLayerFilterAgent);\nawait arcgisAssistantLayerFilterAgent.componentOnReady();\nconsole.log(\"arcgis-assistant-layer-filter-agent is ready to go!\");\n```"}],"return":{"type":{"text":"Promise<this>","references":[{"name":"Promise","module":"lib/lib.es5.d.ts","package":"typescript","start":0,"end":7}]}},"inheritedFrom":{"name":"PublicLitElement","module":"PublicLitElement","package":"@arcgis/lumina"},"signature":"(): Promise<this>"}],"attributes":[{"name":"reference-element","type":{"text":"string","values":[{"type":"string"}]},"fieldName":"referenceElement"}],"importPath":"components/arcgis-assistant-layer-filter-agent"}],"exports":[{"kind":"custom-element-definition","name":"arcgis-assistant-layer-filter-agent","declaration":{"name":"ArcgisAssistantLayerFilterAgent"}}]},{"kind":"javascript-module","path":"components/arcgis-assistant-layer-query-agent","sourcePath":"src/components/assistant/assistant-agents/assistant-layer-query-agent/assistant-layer-query-agent.tsx","declarations":[{"kind":"class","name":"ArcgisAssistantLayerQueryAgent","customElement":true,"tagName":"arcgis-assistant-layer-query-agent","pascalCaseName":"ArcgisAssistantLayerQueryAgent","docsTags":[{"name":"internal"}],"demos":[{"description":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/ai-components/arcgis-assistant-layer-query-agent/"}],"superclass":{"name":"PublicLitElement","module":"PublicLitElement","package":"@arcgis/lumina"},"members":[{"kind":"field","name":"referenceElement","type":{"text":"ArcgisMap | string | undefined","references":[{"name":"ArcgisMap","module":"components/arcgis-map","package":"@arcgis/map-components","start":0,"end":9}],"values":[{"type":"string"},{"type":"object"}]},"attribute":"reference-element"},{"kind":"method","name":"componentOnReady","description":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisAssistantLayerQueryAgent = document.querySelector(\"arcgis-assistant-layer-query-agent\");\ndocument.body.append(arcgisAssistantLayerQueryAgent);\nawait arcgisAssistantLayerQueryAgent.componentOnReady();\nconsole.log(\"arcgis-assistant-layer-query-agent is ready to go!\");\n```"}],"return":{"type":{"text":"Promise<this>","references":[{"name":"Promise","module":"lib/lib.es5.d.ts","package":"typescript","start":0,"end":7}]}},"inheritedFrom":{"name":"PublicLitElement","module":"PublicLitElement","package":"@arcgis/lumina"},"signature":"(): Promise<this>"}],"attributes":[{"name":"reference-element","type":{"text":"string","values":[{"type":"string"}]},"fieldName":"referenceElement"}],"importPath":"components/arcgis-assistant-layer-query-agent"}],"exports":[{"kind":"custom-element-definition","name":"arcgis-assistant-layer-query-agent","declaration":{"name":"ArcgisAssistantLayerQueryAgent"}}]},{"kind":"javascript-module","path":"components/arcgis-assistant-layer-styling-agent","sourcePath":"src/components/assistant/assistant-agents/assistant-layer-styling-agent/assistant-layer-styling-agent.tsx","declarations":[{"kind":"class","name":"ArcgisAssistantLayerStylingAgent","customElement":true,"tagName":"arcgis-assistant-layer-styling-agent","pascalCaseName":"ArcgisAssistantLayerStylingAgent","docsTags":[{"name":"internal"}],"demos":[{"description":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/ai-components/arcgis-assistant-layer-styling-agent/"}],"superclass":{"name":"PublicLitElement","module":"PublicLitElement","package":"@arcgis/lumina"},"members":[{"kind":"field","name":"referenceElement","type":{"text":"ArcgisMap | string | undefined","references":[{"name":"ArcgisMap","module":"components/arcgis-map","package":"@arcgis/map-components","start":0,"end":9}],"values":[{"type":"string"},{"type":"object"}]},"attribute":"reference-element"},{"kind":"method","name":"componentOnReady","description":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisAssistantLayerStylingAgent = document.querySelector(\"arcgis-assistant-layer-styling-agent\");\ndocument.body.append(arcgisAssistantLayerStylingAgent);\nawait arcgisAssistantLayerStylingAgent.componentOnReady();\nconsole.log(\"arcgis-assistant-layer-styling-agent is ready to go!\");\n```"}],"return":{"type":{"text":"Promise<this>","references":[{"name":"Promise","module":"lib/lib.es5.d.ts","package":"typescript","start":0,"end":7}]}},"inheritedFrom":{"name":"PublicLitElement","module":"PublicLitElement","package":"@arcgis/lumina"},"signature":"(): Promise<this>"}],"attributes":[{"name":"reference-element","type":{"text":"string","values":[{"type":"string"}]},"fieldName":"referenceElement"}],"importPath":"components/arcgis-assistant-layer-styling-agent"}],"exports":[{"kind":"custom-element-definition","name":"arcgis-assistant-layer-styling-agent","declaration":{"name":"ArcgisAssistantLayerStylingAgent"}}]},{"kind":"javascript-module","path":"components/arcgis-assistant-navigation-agent","sourcePath":"src/components/assistant/assistant-agents/assistant-navigation-agent/assistant-navigation-agent.tsx","declarations":[{"kind":"class","name":"ArcgisAssistantNavigationAgent","customElement":true,"tagName":"arcgis-assistant-navigation-agent","pascalCaseName":"ArcgisAssistantNavigationAgent","description":"The Navigation Agent component enables the end user to navigate to different areas of a web map.\nIt allows you to type in a place name, address, or layer title to navigate to the desired location.\nCurrently, this is only scoped to navigation within a 2D map view.\n\nThis is an unrendered component that must be added as a child of the `arcgis-assistant` component in either HTML or JavaScript.\n\n```html\n<arcgis-assistant>\n <arcgis-assistant-navigation-agent></arcgis-assistant-navigation-agent>\n</arcgis-assistant>\n```\n\n```js\nconst assistant = document.querySelector(\"arcgis-assistant\");\nconst navigationAgent = document.createElement(\"arcgis-assistant-navigation-agent\");\nassistant.appendChild(navigationAgent);\n```","docsTags":[{"name":"since","text":"5.0"},{"name":"beta"},{"name":"see","text":"[arcgis-assistant](https://developers.arcgis.com/javascript/latest/references/ai-components/arcgis-assistant/)"}],"demos":[{"description":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/ai-components/arcgis-assistant-navigation-agent/"},{"description":"Navigation Agent","url":"https://developers.arcgis.com/javascript/latest/storybook/ai-components/?path=/story/arcgis-assistant-navigation-agent--demo&singleStory=true"}],"superclass":{"name":"PublicLitElement","module":"PublicLitElement","package":"@arcgis/lumina"},"members":[{"kind":"field","name":"referenceElement","description":"A reference to the map element or its ID string used to resolve the MapView for this agent.\nIf not provided, the agent will attempt to find the closest parent `arcgis-map` element.","type":{"text":"ArcgisMap | string | undefined","references":[{"name":"ArcgisMap","module":"components/arcgis-map","package":"@arcgis/map-components","start":0,"end":9}],"values":[{"type":"string"},{"type":"object"}]},"attribute":"reference-element"},{"kind":"method","name":"componentOnReady","description":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisAssistantNavigationAgent = document.querySelector(\"arcgis-assistant-navigation-agent\");\ndocument.body.append(arcgisAssistantNavigationAgent);\nawait arcgisAssistantNavigationAgent.componentOnReady();\nconsole.log(\"arcgis-assistant-navigation-agent is ready to go!\");\n```"}],"return":{"type":{"text":"Promise<this>","references":[{"name":"Promise","module":"lib/lib.es5.d.ts","package":"typescript","start":0,"end":7}]}},"inheritedFrom":{"name":"PublicLitElement","module":"PublicLitElement","package":"@arcgis/lumina"},"signature":"(): Promise<this>"}],"attributes":[{"name":"reference-element","description":"A reference to the map element or its ID string used to resolve the MapView for this agent.\nIf not provided, the agent will attempt to find the closest parent `arcgis-map` element.","type":{"text":"string","values":[{"type":"string"}]},"fieldName":"referenceElement"}],"importPath":"components/arcgis-assistant-navigation-agent"}],"exports":[{"kind":"custom-element-definition","name":"arcgis-assistant-navigation-agent","declaration":{"name":"ArcgisAssistantNavigationAgent"}}]},{"kind":"javascript-module","path":"components/arcgis-assistant-chat","sourcePath":"src/components/assistant/assistant-chat/assistant-chat.tsx","declarations":[{"kind":"class","name":"ArcgisAssistantChat","customElement":true,"tagName":"arcgis-assistant-chat","pascalCaseName":"ArcgisAssistantChat","docsTags":[{"name":"internal"}],"demos":[{"description":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/ai-components/arcgis-assistant-chat/"}],"superclass":{"name":"PublicLitElement","module":"PublicLitElement","package":"@arcgis/lumina"},"members":[{"kind":"field","name":"loading","type":{"text":"boolean","values":[{"type":"boolean"}]},"default":"false","attribute":"loading"},{"kind":"field","name":"loadingMessage","type":{"text":"string","values":[{"type":"string"}]},"default":"\"\"","attribute":"loading-message"},{"kind":"field","name":"messages","type":{"text":"Collection<{\n type: \"prompt\" | \"response\";\n content?: string;\n log?: string;\n error?: string;\n}>","references":[{"name":"default","module":"core/Collection.js","package":"@arcgis/core","viewUrl":"https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html","start":0,"end":10}]}},{"kind":"field","name":"user","type":{"text":"string | undefined","values":[{"type":"string"}]},"attribute":"user"},{"kind":"method","name":"componentOnReady","description":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisAssistantChat = document.querySelector(\"arcgis-assistant-chat\");\ndocument.body.append(arcgisAssistantChat);\nawait arcgisAssistantChat.componentOnReady();\nconsole.log(\"arcgis-assistant-chat is ready to go!\");\n```"}],"return":{"type":{"text":"Promise<this>","references":[{"name":"Promise","module":"lib/lib.es5.d.ts","package":"typescript","start":0,"end":7}]}},"inheritedFrom":{"name":"PublicLitElement","module":"PublicLitElement","package":"@arcgis/lumina"},"signature":"(): Promise<this>"}],"attributes":[{"name":"loading","type":{"text":"boolean","values":[{"type":"boolean"}]},"default":"false","fieldName":"loading"},{"name":"loading-message","type":{"text":"string","values":[{"type":"string"}]},"default":"\"\"","fieldName":"loadingMessage"},{"name":"user","type":{"text":"string","values":[{"type":"string"}]},"fieldName":"user"}],"importPath":"components/arcgis-assistant-chat"}],"exports":[{"kind":"custom-element-definition","name":"arcgis-assistant-chat","declaration":{"name":"ArcgisAssistantChat"}}]},{"kind":"javascript-module","path":"components/arcgis-assistant-chat-card","sourcePath":"src/components/assistant/assistant-chat-card/assistant-chat-card.tsx","declarations":[{"kind":"class","name":"ArcgisAssistantChatCard","customElement":true,"tagName":"arcgis-assistant-chat-card","pascalCaseName":"ArcgisAssistantChatCard","docsTags":[{"name":"internal"}],"demos":[{"description":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/ai-components/arcgis-assistant-chat-card/"}],"superclass":{"name":"PublicLitElement","module":"PublicLitElement","package":"@arcgis/lumina"},"members":[{"kind":"field","name":"content","type":{"text":"string | undefined","values":[{"type":"string"}]},"attribute":"content"},{"kind":"field","name":"error","type":{"text":"string | undefined","values":[{"type":"string"}]},"attribute":"error"},{"kind":"field","name":"feedbackDisabled","type":{"text":"boolean","values":[{"type":"boolean"}]},"default":"false","attribute":"feedback-disabled"},{"kind":"field","name":"loading","type":{"text":"boolean","values":[{"type":"boolean"}]},"default":"false","attribute":"loading"},{"kind":"field","name":"loadingMessage","type":{"text":"string | undefined","values":[{"type":"string"}]},"attribute":"loading-message"},{"kind":"field","name":"log","type":{"text":"string | undefined","values":[{"type":"string"}]},"attribute":"log"},{"kind":"field","name":"timestampDisabled","type":{"text":"boolean","values":[{"type":"boolean"}]},"default":"false","attribute":"timestamp-disabled"},{"kind":"field","name":"type","type":{"text":"\"prompt\" | \"response\"","values":[{"type":"string","value":"prompt"},{"type":"string","value":"response"}]},"default":"\"prompt\"","attribute":"type"},{"kind":"field","name":"user","type":{"text":"string | undefined","values":[{"type":"string"}]},"attribute":"user"},{"kind":"method","name":"componentOnReady","description":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisAssistantChatCard = document.querySelector(\"arcgis-assistant-chat-card\");\ndocument.body.append(arcgisAssistantChatCard);\nawait arcgisAssistantChatCard.componentOnReady();\nconsole.log(\"arcgis-assistant-chat-card is ready to go!\");\n```"}],"return":{"type":{"text":"Promise<this>","references":[{"name":"Promise","module":"lib/lib.es5.d.ts","package":"typescript","start":0,"end":7}]}},"inheritedFrom":{"name":"PublicLitElement","module":"PublicLitElement","package":"@arcgis/lumina"},"signature":"(): Promise<this>"}],"attributes":[{"name":"content","type":{"text":"string","values":[{"type":"string"}]},"fieldName":"content"},{"name":"error","type":{"text":"string","values":[{"type":"string"}]},"fieldName":"error"},{"name":"feedback-disabled","type":{"text":"boolean","values":[{"type":"boolean"}]},"default":"false","fieldName":"feedbackDisabled"},{"name":"loading","type":{"text":"boolean","values":[{"type":"boolean"}]},"default":"false","fieldName":"loading"},{"name":"loading-message","type":{"text":"string","values":[{"type":"string"}]},"fieldName":"loadingMessage"},{"name":"log","type":{"text":"string","values":[{"type":"string"}]},"fieldName":"log"},{"name":"timestamp-disabled","type":{"text":"boolean","values":[{"type":"boolean"}]},"default":"false","fieldName":"timestampDisabled"},{"name":"type","type":{"text":"\"prompt\" | \"response\"","values":[{"type":"string","value":"prompt"},{"type":"string","value":"response"}]},"default":"\"prompt\"","fieldName":"type"},{"name":"user","type":{"text":"string","values":[{"type":"string"}]},"fieldName":"user"}],"importPath":"components/arcgis-assistant-chat-card"}],"exports":[{"kind":"custom-element-definition","name":"arcgis-assistant-chat-card","declaration":{"name":"ArcgisAssistantChatCard"}}]},{"kind":"javascript-module","path":"components/arcgis-assistant-chat-card-content","sourcePath":"src/components/assistant/assistant-chat-card-content/assistant-chat-card-content.tsx","declarations":[{"kind":"class","name":"ArcgisAssistantChatCardContent","customElement":true,"tagName":"arcgis-assistant-chat-card-content","pascalCaseName":"ArcgisAssistantChatCardContent","docsTags":[{"name":"internal"}],"demos":[{"description":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/ai-components/arcgis-assistant-chat-card-content/"}],"superclass":{"name":"PublicLitElement","module":"PublicLitElement","package":"@arcgis/lumina"},"members":[{"kind":"field","name":"content","type":{"text":"string | undefined","values":[{"type":"string"}]},"attribute":"content"},{"kind":"field","name":"loading","type":{"text":"boolean","values":[{"type":"boolean"}]},"default":"false","attribute":"loading"},{"kind":"field","name":"loadingMessage","type":{"text":"string | undefined","values":[{"type":"string"}]},"attribute":"loading-message"},{"kind":"field","name":"type","type":{"text":"\"chart\" | \"error\" | \"text\"","values":[{"type":"string","value":"chart"},{"type":"string","value":"error"},{"type":"string","value":"text"}]},"default":"\"text\"","attribute":"type"},{"kind":"method","name":"componentOnReady","description":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisAssistantChatCardContent = document.querySelector(\"arcgis-assistant-chat-card-content\");\ndocument.body.append(arcgisAssistantChatCardContent);\nawait arcgisAssistantChatCardContent.componentOnReady();\nconsole.log(\"arcgis-assistant-chat-card-content is ready to go!\");\n```"}],"return":{"type":{"text":"Promise<this>","references":[{"name":"Promise","module":"lib/lib.es5.d.ts","package":"typescript","start":0,"end":7}]}},"inheritedFrom":{"name":"PublicLitElement","module":"PublicLitElement","package":"@arcgis/lumina"},"signature":"(): Promise<this>"}],"attributes":[{"name":"content","type":{"text":"string","values":[{"type":"string"}]},"fieldName":"content"},{"name":"loading","type":{"text":"boolean","values":[{"type":"boolean"}]},"default":"false","fieldName":"loading"},{"name":"loading-message","type":{"text":"string","values":[{"type":"string"}]},"fieldName":"loadingMessage"},{"name":"type","type":{"text":"\"chart\" | \"error\" | \"text\"","values":[{"type":"string","value":"chart"},{"type":"string","value":"error"},{"type":"string","value":"text"}]},"default":"\"text\"","fieldName":"type"}],"importPath":"components/arcgis-assistant-chat-card-content"}],"exports":[{"kind":"custom-element-definition","name":"arcgis-assistant-chat-card-content","declaration":{"name":"ArcgisAssistantChatCardContent"}}]},{"kind":"javascript-module","path":"components/arcgis-assistant-chat-entry","sourcePath":"src/components/assistant/assistant-chat-entry/assistant-chat-entry.tsx","declarations":[{"kind":"class","name":"ArcgisAssistantChatEntry","customElement":true,"tagName":"arcgis-assistant-chat-entry","pascalCaseName":"ArcgisAssistantChatEntry","docsTags":[{"name":"internal"}],"demos":[{"description":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/ai-components/arcgis-assistant-chat-entry/"}],"superclass":{"name":"PublicLitElement","module":"PublicLitElement","package":"@arcgis/lumina"},"members":[{"kind":"field","name":"awaitingResponse","type":{"text":"boolean","values":[{"type":"boolean"}]},"default":"false","attribute":"awaiting-response"},{"kind":"field","name":"enterKeySubmits","type":{"text":"boolean","values":[{"type":"boolean"}]},"default":"true","attribute":"enter-key-submits"},{"kind":"field","name":"entryPlaceholder","type":{"text":"string | undefined","values":[{"type":"string"}]},"attribute":"entry-placeholder"},{"kind":"field","name":"inputValue","type":{"text":"string","values":[{"type":"string"}]},"default":"\"\"","attribute":"input-value"},{"kind":"field","name":"status","type":{"text":"\"error\" | \"ready\" | \"working\" | undefined","values":[{"type":"string","value":"error"},{"type":"string","value":"ready"},{"type":"string","value":"working"}]},"attribute":"status"},{"kind":"method","name":"componentOnReady","description":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisAssistantChatEntry = document.querySelector(\"arcgis-assistant-chat-entry\");\ndocument.body.append(arcgisAssistantChatEntry);\nawait arcgisAssistantChatEntry.componentOnReady();\nconsole.log(\"arcgis-assistant-chat-entry is ready to go!\");\n```"}],"return":{"type":{"text":"Promise<this>","references":[{"name":"Promise","module":"lib/lib.es5.d.ts","package":"typescript","start":0,"end":7}]}},"inheritedFrom":{"name":"PublicLitElement","module":"PublicLitElement","package":"@arcgis/lumina"},"signature":"(): Promise<this>"}],"attributes":[{"name":"awaiting-response","type":{"text":"boolean","values":[{"type":"boolean"}]},"default":"false","fieldName":"awaitingResponse"},{"name":"enter-key-submits","type":{"text":"boolean","values":[{"type":"boolean"}]},"default":"true","fieldName":"enterKeySubmits"},{"name":"entry-placeholder","type":{"text":"string","values":[{"type":"string"}]},"fieldName":"entryPlaceholder"},{"name":"input-value","type":{"text":"string","values":[{"type":"string"}]},"default":"\"\"","fieldName":"inputValue"},{"name":"status","type":{"text":"\"error\" | \"ready\" | \"working\"","values":[{"type":"string","value":"error"},{"type":"string","value":"ready"},{"type":"string","value":"working"}]},"fieldName":"status"}],"events":[{"name":"arcgisCancel","type":{"text":"void"}},{"name":"arcgisSubmit","type":{"text":"string"}}],"importPath":"components/arcgis-assistant-chat-entry"}],"exports":[{"kind":"custom-element-definition","name":"arcgis-assistant-chat-entry","declaration":{"name":"ArcgisAssistantChatEntry"}}]},{"kind":"javascript-module","path":"components/arcgis-assistant-interrupt","sourcePath":"src/components/assistant/assistant-interrupt/assistant-interrupt.tsx","declarations":[{"kind":"class","name":"ArcgisAssistantInterrupt","customElement":true,"tagName":"arcgis-assistant-interrupt","pascalCaseName":"ArcgisAssistantInterrupt","docsTags":[{"name":"internal"}],"demos":[{"description":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/ai-components/arcgis-assistant-interrupt/"}],"superclass":{"name":"PublicLitElement","module":"PublicLitElement","package":"@arcgis/lumina"},"members":[{"kind":"field","name":"message","type":{"text":"string | undefined","values":[{"type":"string"}]},"attribute":"message"},{"kind":"field","name":"options","type":{"text":"string[] | undefined"}},{"kind":"field","name":"type","type":{"text":"\"boolean-choice\" | \"multi-select\" | \"single-select\" | \"text-input\"","values":[{"type":"string","value":"boolean-choice"},{"type":"string","value":"multi-select"},{"type":"string","value":"single-select"},{"type":"string","value":"text-input"}]},"attribute":"type"},{"kind":"method","name":"componentOnReady","description":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisAssistantInterrupt = document.querySelector(\"arcgis-assistant-interrupt\");\ndocument.body.append(arcgisAssistantInterrupt);\nawait arcgisAssistantInterrupt.componentOnReady();\nconsole.log(\"arcgis-assistant-interrupt is ready to go!\");\n```"}],"return":{"type":{"text":"Promise<this>","references":[{"name":"Promise","module":"lib/lib.es5.d.ts","package":"typescript","start":0,"end":7}]}},"inheritedFrom":{"name":"PublicLitElement","module":"PublicLitElement","package":"@arcgis/lumina"},"signature":"(): Promise<this>"}],"attributes":[{"name":"message","type":{"text":"string","values":[{"type":"string"}]},"fieldName":"message"},{"name":"type","type":{"text":"\"boolean-choice\" | \"multi-select\" | \"single-select\" | \"text-input\"","values":[{"type":"string","value":"boolean-choice"},{"type":"string","value":"multi-select"},{"type":"string","value":"single-select"},{"type":"string","value":"text-input"}]},"fieldName":"type"}],"events":[{"name":"arcgisCancel","type":{"text":"void"}},{"name":"arcgisSubmit","type":{"text":"string[] | string"}}],"importPath":"components/arcgis-assistant-interrupt"}],"exports":[{"kind":"custom-element-definition","name":"arcgis-assistant-interrupt","declaration":{"name":"ArcgisAssistantInterrupt"}}]},{"kind":"javascript-module","path":"components/arcgis-assistant-shell","sourcePath":"src/components/assistant/assistant-shell/assistant-shell.tsx","declarations":[{"kind":"class","name":"ArcgisAssistantShell","customElement":true,"tagName":"arcgis-assistant-shell","pascalCaseName":"ArcgisAssistantShell","docsTags":[{"name":"internal"}],"demos":[{"description":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/ai-components/arcgis-assistant-shell/"}],"superclass":{"name":"PublicLitElement","module":"PublicLitElement","package":"@arcgis/lumina"},"members":[{"kind":"field","name":"awaitingResponse","type":{"text":"boolean","values":[{"type":"boolean"}]},"default":"false","attribute":"awaiting-response"},{"kind":"field","name":"description","type":{"text":"string","values":[{"type":"string"}]},"default":"\"\"","attribute":"description"},{"kind":"field","name":"entryMessage","type":{"text":"string | undefined","values":[{"type":"string"}]},"attribute":"entry-message"},{"kind":"field","name":"entryMessageClosed","type":{"text":"boolean","values":[{"type":"boolean"}]},"default":"false","attribute":"entry-message-closed"},{"kind":"field","name":"heading","type":{"text":"string | undefined","values":[{"type":"string"}]},"attribute":"heading"},{"kind":"field","name":"inputValue","type":{"text":"string","values":[{"type":"string"}]},"default":"\"\"","attribute":"input-value"},{"kind":"field","name":"loading","type":{"text":"boolean","values":[{"type":"boolean"}]},"default":"false","attribute":"loading"},{"kind":"field","name":"status","type":{"text":"\"error\" | \"ready\" | \"working\" | undefined","values":[{"type":"string","value":"error"},{"type":"string","value":"ready"},{"type":"string","value":"working"}]},"attribute":"status"},{"kind":"field","name":"suggestedPrompts","type":{"text":"string[]"}},{"kind":"method","name":"componentOnReady","description":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisAssistantShell = document.querySelector(\"arcgis-assistant-shell\");\ndocument.body.append(arcgisAssistantShell);\nawait arcgisAssistantShell.componentOnReady();\nconsole.log(\"arcgis-assistant-shell is ready to go!\");\n```"}],"return":{"type":{"text":"Promise<this>","references":[{"name":"Promise","module":"lib/lib.es5.d.ts","package":"typescript","start":0,"end":7}]}},"inheritedFrom":{"name":"PublicLitElement","module":"PublicLitElement","package":"@arcgis/lumina"},"signature":"(): Promise<this>"}],"attributes":[{"name":"awaiting-response","type":{"text":"boolean","values":[{"type":"boolean"}]},"default":"false","fieldName":"awaitingResponse"},{"name":"description","type":{"text":"string","values":[{"type":"string"}]},"default":"\"\"","fieldName":"description"},{"name":"entry-message","type":{"text":"string","values":[{"type":"string"}]},"fieldName":"entryMessage"},{"name":"entry-message-closed","type":{"text":"boolean","values":[{"type":"boolean"}]},"default":"false","fieldName":"entryMessageClosed"},{"name":"heading","type":{"text":"string","values":[{"type":"string"}]},"fieldName":"heading"},{"name":"input-value","type":{"text":"string","values":[{"type":"string"}]},"default":"\"\"","fieldName":"inputValue"},{"name":"loading","type":{"text":"boolean","values":[{"type":"boolean"}]},"default":"false","fieldName":"loading"},{"name":"status","type":{"text":"\"error\" | \"ready\" | \"working\"","values":[{"type":"string","value":"error"},{"type":"string","value":"ready"},{"type":"string","value":"working"}]},"fieldName":"status"}],"events":[{"name":"arcgisCancel","type":{"text":"void"}},{"name":"arcgisSubmit","type":{"text":"string"}}],"importPath":"components/arcgis-assistant-shell"}],"exports":[{"kind":"custom-element-definition","name":"arcgis-assistant-shell","declaration":{"name":"ArcgisAssistantShell"}}]}]}
1
+ {"timestamp":"2026-01-30T06:57:32","compiler":{"name":"@arcgis/lumina-compiler","version":"5.0.0-next.152","typescriptVersion":"5.9.3"},"schemaVersion":"2.1.0","modules":[{"kind":"javascript-module","path":"index","sourcePath":"src/index.ts","declarations":[{"kind":"function","name":"getAssetPath","description":"Get a resolved path from where an asset can be loaded.","parameters":[{"name":"suffix","description":"The relative path for the asset.","type":{"text":"string"}}],"return":{"type":{"text":"string"}}},{"kind":"function","name":"setAssetPath","description":"Used to manually set the base path where package assets (like localization\nand icons) can be found.\n\nBy default, the package assets are loaded from\n`https://js.arcgis.com/<version>/<simplified-package-name>/`. We are hosting\nour assets on a CDN (Content Delivery Network) to ensure fast and reliable\naccess. It is CORS-enabled, so you can load the assets from any domain. This\nis the recommended way to load the assets and avoid bundling them with your\napplication.\n\nHowever, if you need to host the assets locally, you can copy them manually\nas part of your build process and use `setAssetPath` to customize where the\nbrowser will load the assets from.","parameters":[{"name":"path","description":"Relative or absolute path to the assets folder.","type":{"text":"URL | string","references":[{"name":"URL","package":"global:","viewUrl":"https://developer.mozilla.org/docs/Web/API/URL","start":0,"end":3}]}}],"return":{"type":{"text":"void"}}}]},{"kind":"javascript-module","path":"components/arcgis-assistant","sourcePath":"src/components/assistant/assistant.tsx","declarations":[{"kind":"class","name":"ArcgisAssistant","customElement":true,"tagName":"arcgis-assistant","pascalCaseName":"ArcgisAssistant","description":"The ArcGIS Assistant component provides a chat-based natural language interface for interacting with\nmap data and services. This component relies on large language models to understand user prompts and\ngenerate both text and structured responses based on the user's intent and the context of the map.\n\nBy default, the `arcgis-assistant` component does not include any agents. You must register at least one\nagent for the assistant to function. You can register agents declaratively using any of the\navailable agent components, or you can register custom agents.\n\n## Register ArcGIS agents\n\nTo register ArcGIS agents declaratively, include one or more of the following agent components as children\nof the `arcgis-assistant` component. This can be done in HTML or programmatically using JavaScript.\n\n```html\n<arcgis-assistant>\n <arcgis-assistant-navigation-agent></arcgis-assistant-navigation-agent>\n <arcgis-assistant-data-exploration-agent></arcgis-assistant-data-exploration-agent>\n</arcgis-assistant>\n```\n\n```js\nconst assistant = document.querySelector(\"arcgis-assistant\");\nconst navigationAgent = document.createElement(\"arcgis-assistant-navigation-agent\");\nconst dataExplorationAgent = document.createElement(\"arcgis-assistant-data-exploration-agent\");\nassistant.appendChild(navigationAgent);\nassistant.appendChild(dataExplorationAgent);\n```\n\nTo learn more about this component, try out the [demo](#demo) below.","docsTags":[{"name":"since","text":"5.0"},{"name":"beta"},{"name":"see","text":"[arcgis-assistant-data-exploration-agent](https://developers.arcgis.com/javascript/latest/references/ai-components/components/arcgis-assistant-data-exploration-agent/)"},{"name":"see","text":"[arcgis-assistant-navigation-agent](https://developers.arcgis.com/javascript/latest/references/ai-components/components/arcgis-assistant-navigation-agent/)"}],"demos":[{"description":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/ai-components/components/arcgis-assistant/"},{"description":"Assistant Intro\nIntroduction to the Assistant component.","url":"https://developers.arcgis.com/javascript/latest/storybook/ai-components/?path=/story/arcgis-assistant--demo&singleStory=true"}],"superclass":{"name":"PublicLitElement","module":"PublicLitElement","package":"@arcgis/lumina"},"members":[{"kind":"field","name":"description","description":"The description text displayed below the heading in the assistant. This text provides additional\ncontext about the assistant's capabilities and how users can interact with it.","docsTags":[{"name":"example","text":"```html\n<arcgis-assistant description=\"Ask anything about your map data.\"></arcgis-assistant>\n```"},{"name":"example","text":"```js\nconst assistant = document.querySelector(\"arcgis-assistant\");\nassistant.description = \"Ask anything about your map data.\";\n```"}],"type":{"text":"string | undefined","values":[{"type":"string"}]},"attribute":"description"},{"kind":"field","name":"entryMessage","description":"The message to display when the assistant is first loaded.","docsTags":[{"name":"example","text":"```html\n<arcgis-assistant entry-message=\"Hello! How can I assist you with your map today?\"></arcgis-assistant>\n```"},{"name":"example","text":"```js\nconst assistant = document.querySelector(\"arcgis-assistant\");\nassistant.entryMessage = \"Hello! How can I assist you with your map today?\";\n```"}],"type":{"text":"string | undefined","values":[{"type":"string"}]},"attribute":"entry-message"},{"kind":"field","name":"heading","description":"The heading text displayed at the top of the assistant. This name should be concise and\ndescriptive of the assistant's purpose.","docsTags":[{"name":"example","text":"```html\n<arcgis-assistant heading=\"Map Assistant\"></arcgis-assistant>\n```"},{"name":"example","text":"```js\nconst assistant = document.querySelector(\"arcgis-assistant\");\nassistant.heading = \"Map Assistant\";\n```"}],"type":{"text":"string | undefined","values":[{"type":"string"}]},"attribute":"heading"},{"kind":"field","name":"portal","description":"The portal used for authentication and making requests to the LLM via proxy requests.","docsTags":[{"name":"example","text":"```js\nconst assistant = document.querySelector(\"arcgis-assistant\");\nassistant.portal = new Portal({ url: \"https://www.arcgis.com\" });\n```"}],"type":{"text":"Portal","references":[{"name":"default","module":"portal/Portal.js","package":"@arcgis/core","viewUrl":"https://developers.arcgis.com/javascript/latest/references/core/portal/Portal/","start":0,"end":6}]}},{"kind":"field","name":"referenceElement","description":"The reference element to the map that provides context for the assistant and its agents. Currently,\nthis is only scoped to `arcgis-map` elements, but may be extended to support other elements in\nthe future.","docsTags":[{"name":"example","text":"```html\n<arcgis-map id=\"my-map\"></arcgis-map>\n<arcgis-assistant reference-element=\"#my-map\"></arcgis-assistant>\n```"}],"type":{"text":"ArcgisMap | string | null","references":[{"name":"ArcgisMap","module":"components/arcgis-map","package":"@arcgis/map-components","start":0,"end":9}],"values":[{"type":"string"},{"type":"object"}]},"attribute":"reference-element"},{"kind":"field","name":"suggestedPrompts","description":"Suggested prompts to display in the assistant on load. These are intended to help users get started\nwith common queries or actions.You should typically provide 2-3 suggested prompts that are\nrelevant to the context of the data being used and the capabilities of the registered agents.","docsTags":[{"name":"example","text":"```js\nconst assistant = document.querySelector(\"arcgis-assistant\");\nassistant.suggestedPrompts = [\n \"What city has the highest population?\",\n \"What is the highest point in this area?\"\n];\n```"}],"type":{"text":"string[]"}},{"kind":"method","name":"componentOnReady","description":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisAssistant = document.querySelector(\"arcgis-assistant\");\ndocument.body.append(arcgisAssistant);\nawait arcgisAssistant.componentOnReady();\nconsole.log(\"arcgis-assistant is ready to go!\");\n```"}],"return":{"type":{"text":"Promise<this>","references":[{"name":"Promise","module":"lib/lib.es5.d.ts","package":"typescript","start":0,"end":7}]}},"inheritedFrom":{"name":"PublicLitElement","module":"PublicLitElement","package":"@arcgis/lumina"},"signature":"(): Promise<this>"}],"attributes":[{"name":"description","description":"The description text displayed below the heading in the assistant. This text provides additional\ncontext about the assistant's capabilities and how users can interact with it.","type":{"text":"string","values":[{"type":"string"}]},"fieldName":"description"},{"name":"entry-message","description":"The message to display when the assistant is first loaded.","type":{"text":"string","values":[{"type":"string"}]},"fieldName":"entryMessage"},{"name":"heading","description":"The heading text displayed at the top of the assistant. This name should be concise and\ndescriptive of the assistant's purpose.","type":{"text":"string","values":[{"type":"string"}]},"fieldName":"heading"},{"name":"reference-element","description":"The reference element to the map that provides context for the assistant and its agents. Currently,\nthis is only scoped to `arcgis-map` elements, but may be extended to support other elements in\nthe future.","type":{"text":"string","values":[{"type":"string"}]},"fieldName":"referenceElement"}],"slots":[{"name":"","description":"This is the default slot"},{"name":"header-actions-end","description":"Slot for adding actions to the end of the header."},{"name":"entry-message","description":"Slot for adding a welcome or entry message on load."},{"name":"entry-actions-start","description":"Slot for adding actions to the start of the entry area."},{"name":"footer-content","description":"Slot for adding content to the footer."}],"importPath":"components/arcgis-assistant"}],"exports":[{"kind":"custom-element-definition","name":"arcgis-assistant","declaration":{"name":"ArcgisAssistant"}}]},{"kind":"javascript-module","path":"components/arcgis-assistant-agent","sourcePath":"src/components/assistant/assistant-agents/assistant-agent/assistant-agent.tsx","declarations":[{"kind":"class","name":"ArcgisAssistantAgent","customElement":true,"tagName":"arcgis-assistant-agent","pascalCaseName":"ArcgisAssistantAgent","description":"The Assistant Agent component is a generic wrapper for adding custom AI agents into the ArcGIS Assistant component. To define\na custom agent, you must be familiar with [LangGraph](https://docs.langchain.com/oss/javascript/langgraph/overview). Custom agents must\ninclude a StateGraph that defines the agent's graph and subgraphs.\n\n> Building custom agents can only be done using modern JavaScript/TypeScript tooling and cannot be done directly in HTML using\nCDN imports. Therefore, you must use a package manager like npm or yarn to install the required dependencies. Please refer to the\nCreating Custom Agents guide for more instructions.\n\nThis is an unrendered component that must be added as a child of the `arcgis-assistant` component in either HTML or JavaScript.\n\n```html\n<arcgis-assistant></arcgis-assistant>\n```\n\n```js\nconst myCustomAgent = {\n id: \"my-custom-agent\",\n name: \"My Custom Agent\",\n description: \"An agent that does custom things. Use this agent when users want to do custom things.\",\n createGraph: {\n // StateGraph definition using LangGraph\n },\n workspace: {\n // AnnotationRoot definition using LangGraph\n // relevant variables and context required by the agent\n },\n};\n\nconst assistant = document.querySelector(\"arcgis-assistant\");\nconst assistantAgent = document.createElement(\"arcgis-assistant-agent\");\n\nassistantAgent.agent = myCustomAgent;\nassistant.appendChild(assistantAgent);\n```","docsTags":[{"name":"since","text":"5.0"},{"name":"beta"},{"name":"see","text":"[arcgis-assistant](https://developers.arcgis.com/javascript/latest/references/ai-components/components/arcgis-assistant/)"},{"name":"see","text":"[LangGraph documentation](https://docs.langchain.com/oss/javascript/langgraph/overview)"}],"demos":[{"description":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/ai-components/components/arcgis-assistant-agent/"},{"description":"Custom Agent","url":"https://developers.arcgis.com/javascript/latest/storybook/ai-components/?path=/story/arcgis-assistant-agent--demo&singleStory=true"}],"typeParameters":[{"name":"TContext","default":{"text":"Record<string, unknown>","references":[{"name":"Record","package":"global:","viewUrl":"https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type","start":0,"end":6}]}}],"superclass":{"name":"PublicLitElement","module":"PublicLitElement","package":"@arcgis/lumina"},"members":[{"kind":"field","name":"agent","description":"The agent registration object that defines the AI agent's behavior and capabilities.\nThis must include a StateGraph definition (defined using\n[LangGraph](https://docs.langchain.com/oss/javascript/langgraph/overview)).\n\nThis is an agent defined in the client and can be invoked by the assistant within the browser to perform specific tasks\nusing functions defined in the client.\n\nSee the Creating Custom Agents guide for more instructions.","docsTags":[{"name":"required"},{"name":"see","text":"[LangGraph documentation](https://docs.langchain.com/oss/javascript/langgraph/overview)"},{"name":"example","text":"```js\n// An example graph that updates a component property and replies with a confirmation message\nconst myCustomGraph = () => {\n const graph = new StateGraph(myCustomState)\n .addNode(\"updateComponentProperty\", updateComponentProperty)\n .addNode(\"replyComponentPropertyUpdate\", replyComponentPropertyUpdate)\n .addEdge(START, \"updateComponentProperty\")\n .addEdge(\"updateComponentProperty\", \"replyComponentPropertyUpdate\")\n .addEdge(\"replyComponentPropertyUpdate\", END);\n\n return graph;\n};\n\nconst myCustomAgentState = Annotation.Root({\n // This is required to keep track of chat messages between the user and the agent\n messages: Annotation<ChatHistory>({\n reducer: messagesStateReducer,\n default: () => [],\n }),\n // Accumulates user-visible output across graph nodes\n outputMessage: Annotation<string>({\n reducer: (current = \"\", update) =>\n typeof update === \"string\" && update.trim()\n ? current\n ? `${current}\\n\\n${update}`\n : update\n : current,\n default: () => \"\",\n }),\n // Result of the UI action performed by the agent\n // This is a custom type defined by the application\n result: Annotation<UIActionResult | null>({\n reducer: (_current, update) => update ?? null,\n default: () => null,\n }),\n});\n\nconst myCustomAgent = {\n id: \"my-custom-agent\",\n name: \"My Custom Agent\",\n description: \"An agent that does custom things. Use this agent when users want to do custom things.\",\n createGraph: myCustomGraph,\n workspace: myCustomAgentState,\n};\n\nconst assistant = document.querySelector(\"arcgis-assistant\");\nconst assistantAgent = document.createElement(\"arcgis-assistant-agent\");\n\nassistantAgent.agent = myCustomAgent;\nassistant.appendChild(assistantAgent);\n```"}],"type":{"text":"AgentRegistration","references":[{"name":"AgentRegistration","package":"@arcgis/ai-orchestrator","start":0,"end":17}]}},{"kind":"field","name":"context","description":"If the agent requires context, it can be provided via this property and accessed in the\nagent's graph nodes.","docsTags":[{"name":"example","text":"```js\nassistantAgent.context = {\n myData: {\n // custom context data for the agent\n },\n};\n```"}],"type":{"text":"TContext | undefined","references":[{"name":"TContext","start":0,"end":8}]}},{"kind":"method","name":"componentOnReady","description":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisAssistantAgent = document.querySelector(\"arcgis-assistant-agent\");\ndocument.body.append(arcgisAssistantAgent);\nawait arcgisAssistantAgent.componentOnReady();\nconsole.log(\"arcgis-assistant-agent is ready to go!\");\n```"}],"return":{"type":{"text":"Promise<this>","references":[{"name":"Promise","module":"lib/lib.es5.d.ts","package":"typescript","start":0,"end":7}]}},"inheritedFrom":{"name":"PublicLitElement","module":"PublicLitElement","package":"@arcgis/lumina"},"signature":"(): Promise<this>"}],"importPath":"components/arcgis-assistant-agent"}],"exports":[{"kind":"custom-element-definition","name":"arcgis-assistant-agent","declaration":{"name":"ArcgisAssistantAgent"}}]},{"kind":"javascript-module","path":"components/arcgis-assistant-data-exploration-agent","sourcePath":"src/components/assistant/assistant-agents/assistant-data-exploration-agent/assistant-data-exploration-agent.tsx","declarations":[{"kind":"class","name":"ArcgisAssistantDataExplorationAgent","customElement":true,"tagName":"arcgis-assistant-data-exploration-agent","pascalCaseName":"ArcgisAssistantDataExplorationAgent","description":"The Data Exploration Agent component enables the end user to query features, statistics, and spatial proximity\nof layer within a provided web map. Currently, this is only scoped to querying feature layers within\na 2D web map.\n\nThis is an unrendered component that must be added as a child of the `arcgis-assistant` component in either HTML or JavaScript.\n\n```html\n<arcgis-assistant>\n <arcgis-assistant-data-exploration-agent></arcgis-assistant-data-exploration-agent>\n</arcgis-assistant>\n```\n\n```js\nconst assistant = document.querySelector(\"arcgis-assistant\");\nconst dataExplorationAgent = document.createElement(\"arcgis-assistant-data-exploration-agent\");\nassistant.appendChild(dataExplorationAgent);\n```","docsTags":[{"name":"since","text":"5.0"},{"name":"beta"},{"name":"see","text":"[arcgis-assistant](https://developers.arcgis.com/javascript/latest/references/ai-components/components/arcgis-assistant/)"}],"demos":[{"description":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/ai-components/components/arcgis-assistant-data-exploration-agent/"},{"description":"Data Exploration Agent","url":"https://developers.arcgis.com/javascript/latest/storybook/ai-components/?path=/story/arcgis-assistant-data-exploration-agent--demo&singleStory=true"}],"superclass":{"name":"PublicLitElement","module":"PublicLitElement","package":"@arcgis/lumina"},"members":[{"kind":"field","name":"referenceElement","description":"A reference to the map element or its ID string used to resolve the MapView for this agent.\nIf not provided, the agent will attempt to find the closest parent `arcgis-map` element.","type":{"text":"ArcgisMap | string | undefined","references":[{"name":"ArcgisMap","module":"components/arcgis-map","package":"@arcgis/map-components","start":0,"end":9}],"values":[{"type":"string"},{"type":"object"}]},"attribute":"reference-element"},{"kind":"method","name":"componentOnReady","description":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisAssistantDataExplorationAgent = document.querySelector(\"arcgis-assistant-data-exploration-agent\");\ndocument.body.append(arcgisAssistantDataExplorationAgent);\nawait arcgisAssistantDataExplorationAgent.componentOnReady();\nconsole.log(\"arcgis-assistant-data-exploration-agent is ready to go!\");\n```"}],"return":{"type":{"text":"Promise<this>","references":[{"name":"Promise","module":"lib/lib.es5.d.ts","package":"typescript","start":0,"end":7}]}},"inheritedFrom":{"name":"PublicLitElement","module":"PublicLitElement","package":"@arcgis/lumina"},"signature":"(): Promise<this>"}],"attributes":[{"name":"reference-element","description":"A reference to the map element or its ID string used to resolve the MapView for this agent.\nIf not provided, the agent will attempt to find the closest parent `arcgis-map` element.","type":{"text":"string","values":[{"type":"string"}]},"fieldName":"referenceElement"}],"importPath":"components/arcgis-assistant-data-exploration-agent"}],"exports":[{"kind":"custom-element-definition","name":"arcgis-assistant-data-exploration-agent","declaration":{"name":"ArcgisAssistantDataExplorationAgent"}}]},{"kind":"javascript-module","path":"components/arcgis-assistant-layer-filter-agent","sourcePath":"src/components/assistant/assistant-agents/assistant-layer-filter-agent/assistant-layer-filter-agent.tsx","declarations":[{"kind":"class","name":"ArcgisAssistantLayerFilterAgent","customElement":true,"tagName":"arcgis-assistant-layer-filter-agent","pascalCaseName":"ArcgisAssistantLayerFilterAgent","docsTags":[{"name":"internal"}],"demos":[{"description":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/ai-components/components/arcgis-assistant-layer-filter-agent/"}],"superclass":{"name":"PublicLitElement","module":"PublicLitElement","package":"@arcgis/lumina"},"members":[{"kind":"field","name":"referenceElement","type":{"text":"ArcgisMap | string | undefined","references":[{"name":"ArcgisMap","module":"components/arcgis-map","package":"@arcgis/map-components","start":0,"end":9}],"values":[{"type":"string"},{"type":"object"}]},"attribute":"reference-element"},{"kind":"method","name":"componentOnReady","description":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisAssistantLayerFilterAgent = document.querySelector(\"arcgis-assistant-layer-filter-agent\");\ndocument.body.append(arcgisAssistantLayerFilterAgent);\nawait arcgisAssistantLayerFilterAgent.componentOnReady();\nconsole.log(\"arcgis-assistant-layer-filter-agent is ready to go!\");\n```"}],"return":{"type":{"text":"Promise<this>","references":[{"name":"Promise","module":"lib/lib.es5.d.ts","package":"typescript","start":0,"end":7}]}},"inheritedFrom":{"name":"PublicLitElement","module":"PublicLitElement","package":"@arcgis/lumina"},"signature":"(): Promise<this>"}],"attributes":[{"name":"reference-element","type":{"text":"string","values":[{"type":"string"}]},"fieldName":"referenceElement"}],"importPath":"components/arcgis-assistant-layer-filter-agent"}],"exports":[{"kind":"custom-element-definition","name":"arcgis-assistant-layer-filter-agent","declaration":{"name":"ArcgisAssistantLayerFilterAgent"}}]},{"kind":"javascript-module","path":"components/arcgis-assistant-layer-query-agent","sourcePath":"src/components/assistant/assistant-agents/assistant-layer-query-agent/assistant-layer-query-agent.tsx","declarations":[{"kind":"class","name":"ArcgisAssistantLayerQueryAgent","customElement":true,"tagName":"arcgis-assistant-layer-query-agent","pascalCaseName":"ArcgisAssistantLayerQueryAgent","docsTags":[{"name":"internal"}],"demos":[{"description":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/ai-components/components/arcgis-assistant-layer-query-agent/"}],"superclass":{"name":"PublicLitElement","module":"PublicLitElement","package":"@arcgis/lumina"},"members":[{"kind":"field","name":"referenceElement","type":{"text":"ArcgisMap | string | undefined","references":[{"name":"ArcgisMap","module":"components/arcgis-map","package":"@arcgis/map-components","start":0,"end":9}],"values":[{"type":"string"},{"type":"object"}]},"attribute":"reference-element"},{"kind":"method","name":"componentOnReady","description":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisAssistantLayerQueryAgent = document.querySelector(\"arcgis-assistant-layer-query-agent\");\ndocument.body.append(arcgisAssistantLayerQueryAgent);\nawait arcgisAssistantLayerQueryAgent.componentOnReady();\nconsole.log(\"arcgis-assistant-layer-query-agent is ready to go!\");\n```"}],"return":{"type":{"text":"Promise<this>","references":[{"name":"Promise","module":"lib/lib.es5.d.ts","package":"typescript","start":0,"end":7}]}},"inheritedFrom":{"name":"PublicLitElement","module":"PublicLitElement","package":"@arcgis/lumina"},"signature":"(): Promise<this>"}],"attributes":[{"name":"reference-element","type":{"text":"string","values":[{"type":"string"}]},"fieldName":"referenceElement"}],"importPath":"components/arcgis-assistant-layer-query-agent"}],"exports":[{"kind":"custom-element-definition","name":"arcgis-assistant-layer-query-agent","declaration":{"name":"ArcgisAssistantLayerQueryAgent"}}]},{"kind":"javascript-module","path":"components/arcgis-assistant-layer-styling-agent","sourcePath":"src/components/assistant/assistant-agents/assistant-layer-styling-agent/assistant-layer-styling-agent.tsx","declarations":[{"kind":"class","name":"ArcgisAssistantLayerStylingAgent","customElement":true,"tagName":"arcgis-assistant-layer-styling-agent","pascalCaseName":"ArcgisAssistantLayerStylingAgent","docsTags":[{"name":"internal"}],"demos":[{"description":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/ai-components/components/arcgis-assistant-layer-styling-agent/"}],"superclass":{"name":"PublicLitElement","module":"PublicLitElement","package":"@arcgis/lumina"},"members":[{"kind":"field","name":"referenceElement","type":{"text":"ArcgisMap | string | undefined","references":[{"name":"ArcgisMap","module":"components/arcgis-map","package":"@arcgis/map-components","start":0,"end":9}],"values":[{"type":"string"},{"type":"object"}]},"attribute":"reference-element"},{"kind":"method","name":"componentOnReady","description":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisAssistantLayerStylingAgent = document.querySelector(\"arcgis-assistant-layer-styling-agent\");\ndocument.body.append(arcgisAssistantLayerStylingAgent);\nawait arcgisAssistantLayerStylingAgent.componentOnReady();\nconsole.log(\"arcgis-assistant-layer-styling-agent is ready to go!\");\n```"}],"return":{"type":{"text":"Promise<this>","references":[{"name":"Promise","module":"lib/lib.es5.d.ts","package":"typescript","start":0,"end":7}]}},"inheritedFrom":{"name":"PublicLitElement","module":"PublicLitElement","package":"@arcgis/lumina"},"signature":"(): Promise<this>"}],"attributes":[{"name":"reference-element","type":{"text":"string","values":[{"type":"string"}]},"fieldName":"referenceElement"}],"importPath":"components/arcgis-assistant-layer-styling-agent"}],"exports":[{"kind":"custom-element-definition","name":"arcgis-assistant-layer-styling-agent","declaration":{"name":"ArcgisAssistantLayerStylingAgent"}}]},{"kind":"javascript-module","path":"components/arcgis-assistant-navigation-agent","sourcePath":"src/components/assistant/assistant-agents/assistant-navigation-agent/assistant-navigation-agent.tsx","declarations":[{"kind":"class","name":"ArcgisAssistantNavigationAgent","customElement":true,"tagName":"arcgis-assistant-navigation-agent","pascalCaseName":"ArcgisAssistantNavigationAgent","description":"The Navigation Agent component enables the end user to navigate to different areas of a web map.\nIt allows you to type in a place name, address, or layer title to navigate to the desired location.\nCurrently, this is only scoped to navigation within a 2D map view.\n\nThis is an unrendered component that must be added as a child of the `arcgis-assistant` component in either HTML or JavaScript.\n\n```html\n<arcgis-assistant>\n <arcgis-assistant-navigation-agent></arcgis-assistant-navigation-agent>\n</arcgis-assistant>\n```\n\n```js\nconst assistant = document.querySelector(\"arcgis-assistant\");\nconst navigationAgent = document.createElement(\"arcgis-assistant-navigation-agent\");\nassistant.appendChild(navigationAgent);\n```","docsTags":[{"name":"since","text":"5.0"},{"name":"beta"},{"name":"see","text":"[arcgis-assistant](https://developers.arcgis.com/javascript/latest/references/ai-components/components/arcgis-assistant/)"}],"demos":[{"description":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/ai-components/components/arcgis-assistant-navigation-agent/"},{"description":"Navigation Agent","url":"https://developers.arcgis.com/javascript/latest/storybook/ai-components/?path=/story/arcgis-assistant-navigation-agent--demo&singleStory=true"}],"superclass":{"name":"PublicLitElement","module":"PublicLitElement","package":"@arcgis/lumina"},"members":[{"kind":"field","name":"referenceElement","description":"A reference to the map element or its ID string used to resolve the MapView for this agent.\nIf not provided, the agent will attempt to find the closest parent `arcgis-map` element.","type":{"text":"ArcgisMap | string | undefined","references":[{"name":"ArcgisMap","module":"components/arcgis-map","package":"@arcgis/map-components","start":0,"end":9}],"values":[{"type":"string"},{"type":"object"}]},"attribute":"reference-element"},{"kind":"method","name":"componentOnReady","description":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisAssistantNavigationAgent = document.querySelector(\"arcgis-assistant-navigation-agent\");\ndocument.body.append(arcgisAssistantNavigationAgent);\nawait arcgisAssistantNavigationAgent.componentOnReady();\nconsole.log(\"arcgis-assistant-navigation-agent is ready to go!\");\n```"}],"return":{"type":{"text":"Promise<this>","references":[{"name":"Promise","module":"lib/lib.es5.d.ts","package":"typescript","start":0,"end":7}]}},"inheritedFrom":{"name":"PublicLitElement","module":"PublicLitElement","package":"@arcgis/lumina"},"signature":"(): Promise<this>"}],"attributes":[{"name":"reference-element","description":"A reference to the map element or its ID string used to resolve the MapView for this agent.\nIf not provided, the agent will attempt to find the closest parent `arcgis-map` element.","type":{"text":"string","values":[{"type":"string"}]},"fieldName":"referenceElement"}],"importPath":"components/arcgis-assistant-navigation-agent"}],"exports":[{"kind":"custom-element-definition","name":"arcgis-assistant-navigation-agent","declaration":{"name":"ArcgisAssistantNavigationAgent"}}]},{"kind":"javascript-module","path":"components/arcgis-assistant-chat","sourcePath":"src/components/assistant/assistant-chat/assistant-chat.tsx","declarations":[{"kind":"class","name":"ArcgisAssistantChat","customElement":true,"tagName":"arcgis-assistant-chat","pascalCaseName":"ArcgisAssistantChat","docsTags":[{"name":"internal"}],"demos":[{"description":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/ai-components/components/arcgis-assistant-chat/"}],"superclass":{"name":"PublicLitElement","module":"PublicLitElement","package":"@arcgis/lumina"},"members":[{"kind":"field","name":"loading","type":{"text":"boolean","values":[{"type":"boolean"}]},"default":"false","attribute":"loading"},{"kind":"field","name":"loadingMessage","type":{"text":"string","values":[{"type":"string"}]},"default":"\"\"","attribute":"loading-message"},{"kind":"field","name":"messages","type":{"text":"Collection<{\n type: \"prompt\" | \"response\";\n content?: string;\n log?: string;\n error?: string;\n}>","references":[{"name":"default","module":"core/Collection.js","package":"@arcgis/core","viewUrl":"https://developers.arcgis.com/javascript/latest/references/core/core/Collection/","start":0,"end":10}]}},{"kind":"field","name":"user","type":{"text":"string | undefined","values":[{"type":"string"}]},"attribute":"user"},{"kind":"method","name":"componentOnReady","description":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisAssistantChat = document.querySelector(\"arcgis-assistant-chat\");\ndocument.body.append(arcgisAssistantChat);\nawait arcgisAssistantChat.componentOnReady();\nconsole.log(\"arcgis-assistant-chat is ready to go!\");\n```"}],"return":{"type":{"text":"Promise<this>","references":[{"name":"Promise","module":"lib/lib.es5.d.ts","package":"typescript","start":0,"end":7}]}},"inheritedFrom":{"name":"PublicLitElement","module":"PublicLitElement","package":"@arcgis/lumina"},"signature":"(): Promise<this>"}],"attributes":[{"name":"loading","type":{"text":"boolean","values":[{"type":"boolean"}]},"default":"false","fieldName":"loading"},{"name":"loading-message","type":{"text":"string","values":[{"type":"string"}]},"default":"\"\"","fieldName":"loadingMessage"},{"name":"user","type":{"text":"string","values":[{"type":"string"}]},"fieldName":"user"}],"importPath":"components/arcgis-assistant-chat"}],"exports":[{"kind":"custom-element-definition","name":"arcgis-assistant-chat","declaration":{"name":"ArcgisAssistantChat"}}]},{"kind":"javascript-module","path":"components/arcgis-assistant-chat-card","sourcePath":"src/components/assistant/assistant-chat-card/assistant-chat-card.tsx","declarations":[{"kind":"class","name":"ArcgisAssistantChatCard","customElement":true,"tagName":"arcgis-assistant-chat-card","pascalCaseName":"ArcgisAssistantChatCard","docsTags":[{"name":"internal"}],"demos":[{"description":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/ai-components/components/arcgis-assistant-chat-card/"}],"superclass":{"name":"PublicLitElement","module":"PublicLitElement","package":"@arcgis/lumina"},"members":[{"kind":"field","name":"content","type":{"text":"string | undefined","values":[{"type":"string"}]},"attribute":"content"},{"kind":"field","name":"error","type":{"text":"string | undefined","values":[{"type":"string"}]},"attribute":"error"},{"kind":"field","name":"feedbackDisabled","type":{"text":"boolean","values":[{"type":"boolean"}]},"default":"false","attribute":"feedback-disabled"},{"kind":"field","name":"loading","type":{"text":"boolean","values":[{"type":"boolean"}]},"default":"false","attribute":"loading"},{"kind":"field","name":"loadingMessage","type":{"text":"string | undefined","values":[{"type":"string"}]},"attribute":"loading-message"},{"kind":"field","name":"log","type":{"text":"string | undefined","values":[{"type":"string"}]},"attribute":"log"},{"kind":"field","name":"timestampDisabled","type":{"text":"boolean","values":[{"type":"boolean"}]},"default":"false","attribute":"timestamp-disabled"},{"kind":"field","name":"type","type":{"text":"\"prompt\" | \"response\"","values":[{"type":"string","value":"prompt"},{"type":"string","value":"response"}]},"default":"\"prompt\"","attribute":"type"},{"kind":"field","name":"user","type":{"text":"string | undefined","values":[{"type":"string"}]},"attribute":"user"},{"kind":"method","name":"componentOnReady","description":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisAssistantChatCard = document.querySelector(\"arcgis-assistant-chat-card\");\ndocument.body.append(arcgisAssistantChatCard);\nawait arcgisAssistantChatCard.componentOnReady();\nconsole.log(\"arcgis-assistant-chat-card is ready to go!\");\n```"}],"return":{"type":{"text":"Promise<this>","references":[{"name":"Promise","module":"lib/lib.es5.d.ts","package":"typescript","start":0,"end":7}]}},"inheritedFrom":{"name":"PublicLitElement","module":"PublicLitElement","package":"@arcgis/lumina"},"signature":"(): Promise<this>"}],"attributes":[{"name":"content","type":{"text":"string","values":[{"type":"string"}]},"fieldName":"content"},{"name":"error","type":{"text":"string","values":[{"type":"string"}]},"fieldName":"error"},{"name":"feedback-disabled","type":{"text":"boolean","values":[{"type":"boolean"}]},"default":"false","fieldName":"feedbackDisabled"},{"name":"loading","type":{"text":"boolean","values":[{"type":"boolean"}]},"default":"false","fieldName":"loading"},{"name":"loading-message","type":{"text":"string","values":[{"type":"string"}]},"fieldName":"loadingMessage"},{"name":"log","type":{"text":"string","values":[{"type":"string"}]},"fieldName":"log"},{"name":"timestamp-disabled","type":{"text":"boolean","values":[{"type":"boolean"}]},"default":"false","fieldName":"timestampDisabled"},{"name":"type","type":{"text":"\"prompt\" | \"response\"","values":[{"type":"string","value":"prompt"},{"type":"string","value":"response"}]},"default":"\"prompt\"","fieldName":"type"},{"name":"user","type":{"text":"string","values":[{"type":"string"}]},"fieldName":"user"}],"importPath":"components/arcgis-assistant-chat-card"}],"exports":[{"kind":"custom-element-definition","name":"arcgis-assistant-chat-card","declaration":{"name":"ArcgisAssistantChatCard"}}]},{"kind":"javascript-module","path":"components/arcgis-assistant-chat-card-content","sourcePath":"src/components/assistant/assistant-chat-card-content/assistant-chat-card-content.tsx","declarations":[{"kind":"class","name":"ArcgisAssistantChatCardContent","customElement":true,"tagName":"arcgis-assistant-chat-card-content","pascalCaseName":"ArcgisAssistantChatCardContent","docsTags":[{"name":"internal"}],"demos":[{"description":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/ai-components/components/arcgis-assistant-chat-card-content/"}],"superclass":{"name":"PublicLitElement","module":"PublicLitElement","package":"@arcgis/lumina"},"members":[{"kind":"field","name":"content","type":{"text":"string | undefined","values":[{"type":"string"}]},"attribute":"content"},{"kind":"field","name":"loading","type":{"text":"boolean","values":[{"type":"boolean"}]},"default":"false","attribute":"loading"},{"kind":"field","name":"loadingMessage","type":{"text":"string | undefined","values":[{"type":"string"}]},"attribute":"loading-message"},{"kind":"field","name":"type","type":{"text":"\"chart\" | \"error\" | \"text\"","values":[{"type":"string","value":"chart"},{"type":"string","value":"error"},{"type":"string","value":"text"}]},"default":"\"text\"","attribute":"type"},{"kind":"method","name":"componentOnReady","description":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisAssistantChatCardContent = document.querySelector(\"arcgis-assistant-chat-card-content\");\ndocument.body.append(arcgisAssistantChatCardContent);\nawait arcgisAssistantChatCardContent.componentOnReady();\nconsole.log(\"arcgis-assistant-chat-card-content is ready to go!\");\n```"}],"return":{"type":{"text":"Promise<this>","references":[{"name":"Promise","module":"lib/lib.es5.d.ts","package":"typescript","start":0,"end":7}]}},"inheritedFrom":{"name":"PublicLitElement","module":"PublicLitElement","package":"@arcgis/lumina"},"signature":"(): Promise<this>"}],"attributes":[{"name":"content","type":{"text":"string","values":[{"type":"string"}]},"fieldName":"content"},{"name":"loading","type":{"text":"boolean","values":[{"type":"boolean"}]},"default":"false","fieldName":"loading"},{"name":"loading-message","type":{"text":"string","values":[{"type":"string"}]},"fieldName":"loadingMessage"},{"name":"type","type":{"text":"\"chart\" | \"error\" | \"text\"","values":[{"type":"string","value":"chart"},{"type":"string","value":"error"},{"type":"string","value":"text"}]},"default":"\"text\"","fieldName":"type"}],"importPath":"components/arcgis-assistant-chat-card-content"}],"exports":[{"kind":"custom-element-definition","name":"arcgis-assistant-chat-card-content","declaration":{"name":"ArcgisAssistantChatCardContent"}}]},{"kind":"javascript-module","path":"components/arcgis-assistant-chat-entry","sourcePath":"src/components/assistant/assistant-chat-entry/assistant-chat-entry.tsx","declarations":[{"kind":"class","name":"ArcgisAssistantChatEntry","customElement":true,"tagName":"arcgis-assistant-chat-entry","pascalCaseName":"ArcgisAssistantChatEntry","docsTags":[{"name":"internal"}],"demos":[{"description":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/ai-components/components/arcgis-assistant-chat-entry/"}],"superclass":{"name":"PublicLitElement","module":"PublicLitElement","package":"@arcgis/lumina"},"members":[{"kind":"field","name":"awaitingResponse","type":{"text":"boolean","values":[{"type":"boolean"}]},"default":"false","attribute":"awaiting-response"},{"kind":"field","name":"enterKeySubmits","type":{"text":"boolean","values":[{"type":"boolean"}]},"default":"true","attribute":"enter-key-submits"},{"kind":"field","name":"entryPlaceholder","type":{"text":"string | undefined","values":[{"type":"string"}]},"attribute":"entry-placeholder"},{"kind":"field","name":"inputValue","type":{"text":"string","values":[{"type":"string"}]},"default":"\"\"","attribute":"input-value"},{"kind":"field","name":"status","type":{"text":"\"error\" | \"ready\" | \"working\" | undefined","values":[{"type":"string","value":"error"},{"type":"string","value":"ready"},{"type":"string","value":"working"}]},"attribute":"status"},{"kind":"method","name":"componentOnReady","description":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisAssistantChatEntry = document.querySelector(\"arcgis-assistant-chat-entry\");\ndocument.body.append(arcgisAssistantChatEntry);\nawait arcgisAssistantChatEntry.componentOnReady();\nconsole.log(\"arcgis-assistant-chat-entry is ready to go!\");\n```"}],"return":{"type":{"text":"Promise<this>","references":[{"name":"Promise","module":"lib/lib.es5.d.ts","package":"typescript","start":0,"end":7}]}},"inheritedFrom":{"name":"PublicLitElement","module":"PublicLitElement","package":"@arcgis/lumina"},"signature":"(): Promise<this>"}],"attributes":[{"name":"awaiting-response","type":{"text":"boolean","values":[{"type":"boolean"}]},"default":"false","fieldName":"awaitingResponse"},{"name":"enter-key-submits","type":{"text":"boolean","values":[{"type":"boolean"}]},"default":"true","fieldName":"enterKeySubmits"},{"name":"entry-placeholder","type":{"text":"string","values":[{"type":"string"}]},"fieldName":"entryPlaceholder"},{"name":"input-value","type":{"text":"string","values":[{"type":"string"}]},"default":"\"\"","fieldName":"inputValue"},{"name":"status","type":{"text":"\"error\" | \"ready\" | \"working\"","values":[{"type":"string","value":"error"},{"type":"string","value":"ready"},{"type":"string","value":"working"}]},"fieldName":"status"}],"events":[{"name":"arcgisCancel","type":{"text":"void"}},{"name":"arcgisSubmit","type":{"text":"string"}}],"importPath":"components/arcgis-assistant-chat-entry"}],"exports":[{"kind":"custom-element-definition","name":"arcgis-assistant-chat-entry","declaration":{"name":"ArcgisAssistantChatEntry"}}]},{"kind":"javascript-module","path":"components/arcgis-assistant-interrupt","sourcePath":"src/components/assistant/assistant-interrupt/assistant-interrupt.tsx","declarations":[{"kind":"class","name":"ArcgisAssistantInterrupt","customElement":true,"tagName":"arcgis-assistant-interrupt","pascalCaseName":"ArcgisAssistantInterrupt","docsTags":[{"name":"internal"}],"demos":[{"description":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/ai-components/components/arcgis-assistant-interrupt/"}],"superclass":{"name":"PublicLitElement","module":"PublicLitElement","package":"@arcgis/lumina"},"members":[{"kind":"field","name":"message","type":{"text":"string | undefined","values":[{"type":"string"}]},"attribute":"message"},{"kind":"field","name":"options","type":{"text":"string[] | undefined"}},{"kind":"field","name":"type","type":{"text":"\"boolean-choice\" | \"multi-select\" | \"single-select\" | \"text-input\"","values":[{"type":"string","value":"boolean-choice"},{"type":"string","value":"multi-select"},{"type":"string","value":"single-select"},{"type":"string","value":"text-input"}]},"attribute":"type"},{"kind":"method","name":"componentOnReady","description":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisAssistantInterrupt = document.querySelector(\"arcgis-assistant-interrupt\");\ndocument.body.append(arcgisAssistantInterrupt);\nawait arcgisAssistantInterrupt.componentOnReady();\nconsole.log(\"arcgis-assistant-interrupt is ready to go!\");\n```"}],"return":{"type":{"text":"Promise<this>","references":[{"name":"Promise","module":"lib/lib.es5.d.ts","package":"typescript","start":0,"end":7}]}},"inheritedFrom":{"name":"PublicLitElement","module":"PublicLitElement","package":"@arcgis/lumina"},"signature":"(): Promise<this>"}],"attributes":[{"name":"message","type":{"text":"string","values":[{"type":"string"}]},"fieldName":"message"},{"name":"type","type":{"text":"\"boolean-choice\" | \"multi-select\" | \"single-select\" | \"text-input\"","values":[{"type":"string","value":"boolean-choice"},{"type":"string","value":"multi-select"},{"type":"string","value":"single-select"},{"type":"string","value":"text-input"}]},"fieldName":"type"}],"events":[{"name":"arcgisCancel","type":{"text":"void"}},{"name":"arcgisSubmit","type":{"text":"string[] | string"}}],"importPath":"components/arcgis-assistant-interrupt"}],"exports":[{"kind":"custom-element-definition","name":"arcgis-assistant-interrupt","declaration":{"name":"ArcgisAssistantInterrupt"}}]},{"kind":"javascript-module","path":"components/arcgis-assistant-shell","sourcePath":"src/components/assistant/assistant-shell/assistant-shell.tsx","declarations":[{"kind":"class","name":"ArcgisAssistantShell","customElement":true,"tagName":"arcgis-assistant-shell","pascalCaseName":"ArcgisAssistantShell","docsTags":[{"name":"internal"}],"demos":[{"description":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/ai-components/components/arcgis-assistant-shell/"}],"superclass":{"name":"PublicLitElement","module":"PublicLitElement","package":"@arcgis/lumina"},"members":[{"kind":"field","name":"awaitingResponse","type":{"text":"boolean","values":[{"type":"boolean"}]},"default":"false","attribute":"awaiting-response"},{"kind":"field","name":"description","type":{"text":"string","values":[{"type":"string"}]},"default":"\"\"","attribute":"description"},{"kind":"field","name":"entryMessage","type":{"text":"string | undefined","values":[{"type":"string"}]},"attribute":"entry-message"},{"kind":"field","name":"entryMessageClosed","type":{"text":"boolean","values":[{"type":"boolean"}]},"default":"false","attribute":"entry-message-closed"},{"kind":"field","name":"heading","type":{"text":"string | undefined","values":[{"type":"string"}]},"attribute":"heading"},{"kind":"field","name":"inputValue","type":{"text":"string","values":[{"type":"string"}]},"default":"\"\"","attribute":"input-value"},{"kind":"field","name":"loading","type":{"text":"boolean","values":[{"type":"boolean"}]},"default":"false","attribute":"loading"},{"kind":"field","name":"status","type":{"text":"\"error\" | \"ready\" | \"working\" | undefined","values":[{"type":"string","value":"error"},{"type":"string","value":"ready"},{"type":"string","value":"working"}]},"attribute":"status"},{"kind":"field","name":"suggestedPrompts","type":{"text":"string[]"}},{"kind":"method","name":"componentOnReady","description":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisAssistantShell = document.querySelector(\"arcgis-assistant-shell\");\ndocument.body.append(arcgisAssistantShell);\nawait arcgisAssistantShell.componentOnReady();\nconsole.log(\"arcgis-assistant-shell is ready to go!\");\n```"}],"return":{"type":{"text":"Promise<this>","references":[{"name":"Promise","module":"lib/lib.es5.d.ts","package":"typescript","start":0,"end":7}]}},"inheritedFrom":{"name":"PublicLitElement","module":"PublicLitElement","package":"@arcgis/lumina"},"signature":"(): Promise<this>"}],"attributes":[{"name":"awaiting-response","type":{"text":"boolean","values":[{"type":"boolean"}]},"default":"false","fieldName":"awaitingResponse"},{"name":"description","type":{"text":"string","values":[{"type":"string"}]},"default":"\"\"","fieldName":"description"},{"name":"entry-message","type":{"text":"string","values":[{"type":"string"}]},"fieldName":"entryMessage"},{"name":"entry-message-closed","type":{"text":"boolean","values":[{"type":"boolean"}]},"default":"false","fieldName":"entryMessageClosed"},{"name":"heading","type":{"text":"string","values":[{"type":"string"}]},"fieldName":"heading"},{"name":"input-value","type":{"text":"string","values":[{"type":"string"}]},"default":"\"\"","fieldName":"inputValue"},{"name":"loading","type":{"text":"boolean","values":[{"type":"boolean"}]},"default":"false","fieldName":"loading"},{"name":"status","type":{"text":"\"error\" | \"ready\" | \"working\"","values":[{"type":"string","value":"error"},{"type":"string","value":"ready"},{"type":"string","value":"working"}]},"fieldName":"status"}],"events":[{"name":"arcgisCancel","type":{"text":"void"}},{"name":"arcgisSubmit","type":{"text":"string"}}],"importPath":"components/arcgis-assistant-shell"}],"exports":[{"kind":"custom-element-definition","name":"arcgis-assistant-shell","declaration":{"name":"ArcgisAssistantShell"}}]}]}
@@ -1 +1 @@
1
- {"timestamp":"2026-01-29T04:55:54","compiler":{"name":"@arcgis/lumina-compiler","version":"5.0.0-next.151","typescriptVersion":"5.9.3"},"components":[{"filePath":"src/components/assistant/assistant.tsx","tag":"arcgis-assistant","overview":"","readme":"","usage":{},"docs":"The ArcGIS Assistant component provides a chat-based natural language interface for interacting with\nmap data and services. This component relies on large language models to understand user prompts and\ngenerate both text and structured responses based on the user's intent and the context of the map.\n\nBy default, the `arcgis-assistant` component does not include any agents. You must register at least one\nagent for the assistant to function. You can register agents declaratively using any of the\navailable agent components, or you can register custom agents.\n\n## Register ArcGIS agents\n\nTo register ArcGIS agents declaratively, include one or more of the following agent components as children\nof the `arcgis-assistant` component. This can be done in HTML or programmatically using JavaScript.\n\n```html\n<arcgis-assistant>\n <arcgis-assistant-navigation-agent></arcgis-assistant-navigation-agent>\n <arcgis-assistant-data-exploration-agent></arcgis-assistant-data-exploration-agent>\n</arcgis-assistant>\n```\n\n```js\nconst assistant = document.querySelector(\"arcgis-assistant\");\nconst navigationAgent = document.createElement(\"arcgis-assistant-navigation-agent\");\nconst dataExplorationAgent = document.createElement(\"arcgis-assistant-data-exploration-agent\");\nassistant.appendChild(navigationAgent);\nassistant.appendChild(dataExplorationAgent);\n```\n\nTo learn more about this component, try out the [demo](#demo) below.","docsTags":[{"name":"since","text":"5.0"},{"name":"beta"},{"name":"see","text":"[arcgis-assistant-data-exploration-agent](https://developers.arcgis.com/javascript/latest/references/ai-components/arcgis-assistant-data-exploration-agent/)"},{"name":"see","text":"[arcgis-assistant-navigation-agent](https://developers.arcgis.com/javascript/latest/references/ai-components/arcgis-assistant-navigation-agent/)"},{"name":"superclass","text":"{\"name\":\"PublicLitElement\",\"module\":\"PublicLitElement\",\"package\":\"@arcgis/lumina\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"description","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"description","reflectToAttr":false,"docs":"The description text displayed below the heading in the assistant. This text provides additional\ncontext about the assistant's capabilities and how users can interact with it.","docsTags":[{"name":"example","text":"```html\n<arcgis-assistant description=\"Ask anything about your map data.\"></arcgis-assistant>\n```"},{"name":"example","text":"```js\nconst assistant = document.querySelector(\"arcgis-assistant\");\nassistant.description = \"Ask anything about your map data.\";\n```"}],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"entryMessage","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"entry-message","reflectToAttr":false,"docs":"The message to display when the assistant is first loaded.","docsTags":[{"name":"example","text":"```html\n<arcgis-assistant entry-message=\"Hello! How can I assist you with your map today?\"></arcgis-assistant>\n```"},{"name":"example","text":"```js\nconst assistant = document.querySelector(\"arcgis-assistant\");\nassistant.entryMessage = \"Hello! How can I assist you with your map today?\";\n```"}],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"heading","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"heading","reflectToAttr":false,"docs":"The heading text displayed at the top of the assistant. This name should be concise and\ndescriptive of the assistant's purpose.","docsTags":[{"name":"example","text":"```html\n<arcgis-assistant heading=\"Map Assistant\"></arcgis-assistant>\n```"},{"name":"example","text":"```js\nconst assistant = document.querySelector(\"arcgis-assistant\");\nassistant.heading = \"Map Assistant\";\n```"}],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"portal","type":"Portal","complexType":{"original":"Portal","resolved":"Portal","references":{"default":{"location":"import","path":"@arcgis/core/portal/Portal.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The portal used for authentication and making requests to the LLM via proxy requests.","docsTags":[{"name":"example","text":"```js\nconst assistant = document.querySelector(\"arcgis-assistant\");\nassistant.portal = new Portal({ url: \"https://www.arcgis.com\" });\n```"}],"values":[],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisMap | string | null","complexType":{"original":"ArcgisMap | string | null","resolved":"ArcgisMap | string | null","references":{"ArcgisMap":{"location":"import","path":"@arcgis/map-components/components/arcgis-map","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"The reference element to the map that provides context for the assistant and its agents. Currently,\nthis is only scoped to `arcgis-map` elements, but may be extended to support other elements in\nthe future.","docsTags":[{"name":"example","text":"```html\n<arcgis-map id=\"my-map\"></arcgis-map>\n<arcgis-assistant reference-element=\"#my-map\"></arcgis-assistant>\n```"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"suggestedPrompts","type":"string[]","complexType":{"original":"string[]","resolved":"string[]","references":{}},"mutable":true,"reflectToAttr":false,"docs":"Suggested prompts to display in the assistant on load. These are intended to help users get started\nwith common queries or actions.You should typically provide 2-3 suggested prompts that are\nrelevant to the context of the data being used and the capabilities of the registered agents.","docsTags":[{"name":"example","text":"```js\nconst assistant = document.querySelector(\"arcgis-assistant\");\nassistant.suggestedPrompts = [\n \"What city has the highest population?\",\n \"What is the highest point in this area?\"\n];\n```"}],"values":[],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise<this>","docs":""},"complexType":{"signature":"(): Promise<this>","parameters":[],"return":"Promise<this>","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise<this>","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisAssistant = document.querySelector(\"arcgis-assistant\");\ndocument.body.append(arcgisAssistant);\nawait arcgisAssistant.componentOnReady();\nconsole.log(\"arcgis-assistant is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"PublicLitElement\",\"module\":\"PublicLitElement\",\"package\":\"@arcgis/lumina\"}"}]}],"events":[],"styles":[],"slots":[{"name":"","docs":"This is the default slot"},{"name":"header-actions-end","docs":"Slot for adding actions to the end of the header."},{"name":"entry-message","docs":"Slot for adding a welcome or entry message on load."},{"name":"entry-actions-start","docs":"Slot for adding actions to the start of the entry area."},{"name":"footer-content","docs":"Slot for adding content to the footer."}],"parts":[],"listeners":[]},{"filePath":"src/components/assistant/assistant-agents/assistant-agent/assistant-agent.tsx","tag":"arcgis-assistant-agent","overview":"","readme":"","usage":{},"docs":"The Assistant Agent component is a generic wrapper for adding custom AI agents into the ArcGIS Assistant component. To define\na custom agent, you must be familiar with [LangGraph](https://docs.langchain.com/oss/javascript/langgraph/overview). Custom agents must\ninclude a StateGraph that defines the agent's graph and subgraphs.\n\n> Building custom agents can only be done using modern JavaScript/TypeScript tooling and cannot be done directly in HTML using\nCDN imports. Therefore, you must use a package manager like npm or yarn to install the required dependencies. Please refer to the\nCreating Custom Agents guide for more instructions.\n\nThis is an unrendered component that must be added as a child of the `arcgis-assistant` component in either HTML or JavaScript.\n\n```html\n<arcgis-assistant></arcgis-assistant>\n```\n\n```js\nconst myCustomAgent = {\n id: \"my-custom-agent\",\n name: \"My Custom Agent\",\n description: \"An agent that does custom things. Use this agent when users want to do custom things.\",\n createGraph: {\n // StateGraph definition using LangGraph\n },\n workspace: {\n // AnnotationRoot definition using LangGraph\n // relevant variables and context required by the agent\n },\n};\n\nconst assistant = document.querySelector(\"arcgis-assistant\");\nconst assistantAgent = document.createElement(\"arcgis-assistant-agent\");\n\nassistantAgent.agent = myCustomAgent;\nassistant.appendChild(assistantAgent);\n```","docsTags":[{"name":"since","text":"5.0"},{"name":"beta"},{"name":"see","text":"[arcgis-assistant](https://developers.arcgis.com/javascript/latest/references/ai-components/arcgis-assistant/)"},{"name":"see","text":"[LangGraph documentation](https://docs.langchain.com/oss/javascript/langgraph/overview)"},{"name":"superclass","text":"{\"name\":\"PublicLitElement\",\"module\":\"PublicLitElement\",\"package\":\"@arcgis/lumina\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"agent","type":"AgentRegistration","complexType":{"original":"AgentRegistration","resolved":"AgentRegistration","references":{"AgentRegistration":{"location":"import","path":"@arcgis/ai-orchestrator","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The agent registration object that defines the AI agent's behavior and capabilities.\nThis must include a StateGraph definition (defined using\n[LangGraph](https://docs.langchain.com/oss/javascript/langgraph/overview)).\n\nThis is an agent defined in the client and can be invoked by the assistant within the browser to perform specific tasks\nusing functions defined in the client.\n\nSee the Creating Custom Agents guide for more instructions.","docsTags":[{"name":"required"},{"name":"see","text":"[LangGraph documentation](https://docs.langchain.com/oss/javascript/langgraph/overview)"},{"name":"example","text":"```js\n// An example graph that updates a component property and replies with a confirmation message\nconst myCustomGraph = () => {\n const graph = new StateGraph(myCustomState)\n .addNode(\"updateComponentProperty\", updateComponentProperty)\n .addNode(\"replyComponentPropertyUpdate\", replyComponentPropertyUpdate)\n .addEdge(START, \"updateComponentProperty\")\n .addEdge(\"updateComponentProperty\", \"replyComponentPropertyUpdate\")\n .addEdge(\"replyComponentPropertyUpdate\", END);\n\n return graph;\n};\n\nconst myCustomAgentState = Annotation.Root({\n // This is required to keep track of chat messages between the user and the agent\n messages: Annotation<ChatHistory>({\n reducer: messagesStateReducer,\n default: () => [],\n }),\n // Accumulates user-visible output across graph nodes\n outputMessage: Annotation<string>({\n reducer: (current = \"\", update) =>\n typeof update === \"string\" && update.trim()\n ? current\n ? `${current}\\n\\n${update}`\n : update\n : current,\n default: () => \"\",\n }),\n // Result of the UI action performed by the agent\n // This is a custom type defined by the application\n result: Annotation<UIActionResult | null>({\n reducer: (_current, update) => update ?? null,\n default: () => null,\n }),\n});\n\nconst myCustomAgent = {\n id: \"my-custom-agent\",\n name: \"My Custom Agent\",\n description: \"An agent that does custom things. Use this agent when users want to do custom things.\",\n createGraph: myCustomGraph,\n workspace: myCustomAgentState,\n};\n\nconst assistant = document.querySelector(\"arcgis-assistant\");\nconst assistantAgent = document.createElement(\"arcgis-assistant-agent\");\n\nassistantAgent.agent = myCustomAgent;\nassistant.appendChild(assistantAgent);\n```"}],"values":[],"optional":false,"required":true},{"name":"context","type":"TContext | undefined","complexType":{"original":"TContext | undefined","resolved":"TContext | undefined","references":{"TContext":{"location":"local","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"If the agent requires context, it can be provided via this property and accessed in the\nagent's graph nodes.","docsTags":[{"name":"example","text":"```js\nassistantAgent.context = {\n myData: {\n // custom context data for the agent\n },\n};\n```"}],"values":[],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise<this>","docs":""},"complexType":{"signature":"(): Promise<this>","parameters":[],"return":"Promise<this>","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise<this>","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisAssistantAgent = document.querySelector(\"arcgis-assistant-agent\");\ndocument.body.append(arcgisAssistantAgent);\nawait arcgisAssistantAgent.componentOnReady();\nconsole.log(\"arcgis-assistant-agent is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"PublicLitElement\",\"module\":\"PublicLitElement\",\"package\":\"@arcgis/lumina\"}"}]}],"events":[],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/assistant/assistant-agents/assistant-data-exploration-agent/assistant-data-exploration-agent.tsx","tag":"arcgis-assistant-data-exploration-agent","overview":"","readme":"","usage":{},"docs":"The Data Exploration Agent component enables the end user to query features, statistics, and spatial proximity\nof layer within a provided web map. Currently, this is only scoped to querying feature layers within\na 2D web map.\n\nThis is an unrendered component that must be added as a child of the `arcgis-assistant` component in either HTML or JavaScript.\n\n```html\n<arcgis-assistant>\n <arcgis-assistant-data-exploration-agent></arcgis-assistant-data-exploration-agent>\n</arcgis-assistant>\n```\n\n```js\nconst assistant = document.querySelector(\"arcgis-assistant\");\nconst dataExplorationAgent = document.createElement(\"arcgis-assistant-data-exploration-agent\");\nassistant.appendChild(dataExplorationAgent);\n```","docsTags":[{"name":"since","text":"5.0"},{"name":"beta"},{"name":"see","text":"[arcgis-assistant](https://developers.arcgis.com/javascript/latest/references/ai-components/arcgis-assistant/)"},{"name":"superclass","text":"{\"name\":\"PublicLitElement\",\"module\":\"PublicLitElement\",\"package\":\"@arcgis/lumina\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"referenceElement","type":"ArcgisMap | string | undefined","complexType":{"original":"ArcgisMap | string | undefined","resolved":"ArcgisMap | string | undefined","references":{"ArcgisMap":{"location":"import","path":"@arcgis/map-components/components/arcgis-map","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"A reference to the map element or its ID string used to resolve the MapView for this agent.\nIf not provided, the agent will attempt to find the closest parent `arcgis-map` element.","docsTags":[],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise<this>","docs":""},"complexType":{"signature":"(): Promise<this>","parameters":[],"return":"Promise<this>","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise<this>","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisAssistantDataExplorationAgent = document.querySelector(\"arcgis-assistant-data-exploration-agent\");\ndocument.body.append(arcgisAssistantDataExplorationAgent);\nawait arcgisAssistantDataExplorationAgent.componentOnReady();\nconsole.log(\"arcgis-assistant-data-exploration-agent is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"PublicLitElement\",\"module\":\"PublicLitElement\",\"package\":\"@arcgis/lumina\"}"}]}],"events":[],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/assistant/assistant-agents/assistant-layer-filter-agent/assistant-layer-filter-agent.tsx","tag":"arcgis-assistant-layer-filter-agent","overview":"","readme":"","usage":{},"docs":"","docsTags":[{"name":"internal"},{"name":"superclass","text":"{\"name\":\"PublicLitElement\",\"module\":\"PublicLitElement\",\"package\":\"@arcgis/lumina\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"referenceElement","type":"ArcgisMap | string | undefined","complexType":{"original":"ArcgisMap | string | undefined","resolved":"ArcgisMap | string | undefined","references":{"ArcgisMap":{"location":"import","path":"@arcgis/map-components/components/arcgis-map","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"","docsTags":[],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise<this>","docs":""},"complexType":{"signature":"(): Promise<this>","parameters":[],"return":"Promise<this>","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise<this>","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisAssistantLayerFilterAgent = document.querySelector(\"arcgis-assistant-layer-filter-agent\");\ndocument.body.append(arcgisAssistantLayerFilterAgent);\nawait arcgisAssistantLayerFilterAgent.componentOnReady();\nconsole.log(\"arcgis-assistant-layer-filter-agent is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"PublicLitElement\",\"module\":\"PublicLitElement\",\"package\":\"@arcgis/lumina\"}"}]}],"events":[],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/assistant/assistant-agents/assistant-layer-query-agent/assistant-layer-query-agent.tsx","tag":"arcgis-assistant-layer-query-agent","overview":"","readme":"","usage":{},"docs":"","docsTags":[{"name":"internal"},{"name":"superclass","text":"{\"name\":\"PublicLitElement\",\"module\":\"PublicLitElement\",\"package\":\"@arcgis/lumina\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"referenceElement","type":"ArcgisMap | string | undefined","complexType":{"original":"ArcgisMap | string | undefined","resolved":"ArcgisMap | string | undefined","references":{"ArcgisMap":{"location":"import","path":"@arcgis/map-components/components/arcgis-map","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"","docsTags":[],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise<this>","docs":""},"complexType":{"signature":"(): Promise<this>","parameters":[],"return":"Promise<this>","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise<this>","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisAssistantLayerQueryAgent = document.querySelector(\"arcgis-assistant-layer-query-agent\");\ndocument.body.append(arcgisAssistantLayerQueryAgent);\nawait arcgisAssistantLayerQueryAgent.componentOnReady();\nconsole.log(\"arcgis-assistant-layer-query-agent is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"PublicLitElement\",\"module\":\"PublicLitElement\",\"package\":\"@arcgis/lumina\"}"}]}],"events":[],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/assistant/assistant-agents/assistant-layer-styling-agent/assistant-layer-styling-agent.tsx","tag":"arcgis-assistant-layer-styling-agent","overview":"","readme":"","usage":{},"docs":"","docsTags":[{"name":"internal"},{"name":"superclass","text":"{\"name\":\"PublicLitElement\",\"module\":\"PublicLitElement\",\"package\":\"@arcgis/lumina\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"referenceElement","type":"ArcgisMap | string | undefined","complexType":{"original":"ArcgisMap | string | undefined","resolved":"ArcgisMap | string | undefined","references":{"ArcgisMap":{"location":"import","path":"@arcgis/map-components/components/arcgis-map","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"","docsTags":[],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise<this>","docs":""},"complexType":{"signature":"(): Promise<this>","parameters":[],"return":"Promise<this>","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise<this>","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisAssistantLayerStylingAgent = document.querySelector(\"arcgis-assistant-layer-styling-agent\");\ndocument.body.append(arcgisAssistantLayerStylingAgent);\nawait arcgisAssistantLayerStylingAgent.componentOnReady();\nconsole.log(\"arcgis-assistant-layer-styling-agent is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"PublicLitElement\",\"module\":\"PublicLitElement\",\"package\":\"@arcgis/lumina\"}"}]}],"events":[],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/assistant/assistant-agents/assistant-navigation-agent/assistant-navigation-agent.tsx","tag":"arcgis-assistant-navigation-agent","overview":"","readme":"","usage":{},"docs":"The Navigation Agent component enables the end user to navigate to different areas of a web map.\nIt allows you to type in a place name, address, or layer title to navigate to the desired location.\nCurrently, this is only scoped to navigation within a 2D map view.\n\nThis is an unrendered component that must be added as a child of the `arcgis-assistant` component in either HTML or JavaScript.\n\n```html\n<arcgis-assistant>\n <arcgis-assistant-navigation-agent></arcgis-assistant-navigation-agent>\n</arcgis-assistant>\n```\n\n```js\nconst assistant = document.querySelector(\"arcgis-assistant\");\nconst navigationAgent = document.createElement(\"arcgis-assistant-navigation-agent\");\nassistant.appendChild(navigationAgent);\n```","docsTags":[{"name":"since","text":"5.0"},{"name":"beta"},{"name":"see","text":"[arcgis-assistant](https://developers.arcgis.com/javascript/latest/references/ai-components/arcgis-assistant/)"},{"name":"superclass","text":"{\"name\":\"PublicLitElement\",\"module\":\"PublicLitElement\",\"package\":\"@arcgis/lumina\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"referenceElement","type":"ArcgisMap | string | undefined","complexType":{"original":"ArcgisMap | string | undefined","resolved":"ArcgisMap | string | undefined","references":{"ArcgisMap":{"location":"import","path":"@arcgis/map-components/components/arcgis-map","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"A reference to the map element or its ID string used to resolve the MapView for this agent.\nIf not provided, the agent will attempt to find the closest parent `arcgis-map` element.","docsTags":[],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise<this>","docs":""},"complexType":{"signature":"(): Promise<this>","parameters":[],"return":"Promise<this>","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise<this>","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisAssistantNavigationAgent = document.querySelector(\"arcgis-assistant-navigation-agent\");\ndocument.body.append(arcgisAssistantNavigationAgent);\nawait arcgisAssistantNavigationAgent.componentOnReady();\nconsole.log(\"arcgis-assistant-navigation-agent is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"PublicLitElement\",\"module\":\"PublicLitElement\",\"package\":\"@arcgis/lumina\"}"}]}],"events":[],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/assistant/assistant-chat/assistant-chat.tsx","tag":"arcgis-assistant-chat","overview":"","readme":"","usage":{},"docs":"","docsTags":[{"name":"internal"},{"name":"superclass","text":"{\"name\":\"PublicLitElement\",\"module\":\"PublicLitElement\",\"package\":\"@arcgis/lumina\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"loading","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"loading","reflectToAttr":false,"docs":"","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"loadingMessage","type":"string","complexType":{"original":"string","resolved":"string","references":{}},"mutable":true,"attr":"loading-message","reflectToAttr":false,"docs":"","docsTags":[],"default":"\"\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"messages","type":"Collection<{\n type: \"prompt\" | \"response\";\n content?: string;\n log?: string;\n error?: string;\n}>","complexType":{"original":"Collection<{\n type: \"prompt\" | \"response\";\n content?: string;\n log?: string;\n error?: string;\n}>","resolved":"Collection<{\n type: \"prompt\" | \"response\";\n content?: string;\n log?: string;\n error?: string;\n}>","references":{"default":{"location":"import","path":"@arcgis/core/core/Collection.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"","docsTags":[],"values":[],"optional":true,"required":false},{"name":"user","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"user","reflectToAttr":false,"docs":"","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise<this>","docs":""},"complexType":{"signature":"(): Promise<this>","parameters":[],"return":"Promise<this>","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise<this>","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisAssistantChat = document.querySelector(\"arcgis-assistant-chat\");\ndocument.body.append(arcgisAssistantChat);\nawait arcgisAssistantChat.componentOnReady();\nconsole.log(\"arcgis-assistant-chat is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"PublicLitElement\",\"module\":\"PublicLitElement\",\"package\":\"@arcgis/lumina\"}"}]}],"events":[],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/assistant/assistant-chat-card/assistant-chat-card.tsx","tag":"arcgis-assistant-chat-card","overview":"","readme":"","usage":{},"docs":"","docsTags":[{"name":"internal"},{"name":"superclass","text":"{\"name\":\"PublicLitElement\",\"module\":\"PublicLitElement\",\"package\":\"@arcgis/lumina\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"content","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"content","reflectToAttr":false,"docs":"","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"error","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"error","reflectToAttr":false,"docs":"","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"feedbackDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"feedback-disabled","reflectToAttr":false,"docs":"","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"loading","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"loading","reflectToAttr":false,"docs":"","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"loadingMessage","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"loading-message","reflectToAttr":false,"docs":"","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"log","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"log","reflectToAttr":false,"docs":"","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"timestampDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"timestamp-disabled","reflectToAttr":false,"docs":"","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"type","type":"\"prompt\" | \"response\"","complexType":{"original":"\"prompt\" | \"response\"","resolved":"\"prompt\" | \"response\"","references":{}},"mutable":true,"attr":"type","reflectToAttr":false,"docs":"","docsTags":[],"default":"\"prompt\"","values":[{"type":"string","value":"prompt"},{"type":"string","value":"response"}],"optional":true,"required":false},{"name":"user","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"user","reflectToAttr":false,"docs":"","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise<this>","docs":""},"complexType":{"signature":"(): Promise<this>","parameters":[],"return":"Promise<this>","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise<this>","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisAssistantChatCard = document.querySelector(\"arcgis-assistant-chat-card\");\ndocument.body.append(arcgisAssistantChatCard);\nawait arcgisAssistantChatCard.componentOnReady();\nconsole.log(\"arcgis-assistant-chat-card is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"PublicLitElement\",\"module\":\"PublicLitElement\",\"package\":\"@arcgis/lumina\"}"}]}],"events":[],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/assistant/assistant-chat-card-content/assistant-chat-card-content.tsx","tag":"arcgis-assistant-chat-card-content","overview":"","readme":"","usage":{},"docs":"","docsTags":[{"name":"internal"},{"name":"superclass","text":"{\"name\":\"PublicLitElement\",\"module\":\"PublicLitElement\",\"package\":\"@arcgis/lumina\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"content","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"content","reflectToAttr":false,"docs":"","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"loading","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"loading","reflectToAttr":false,"docs":"","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"loadingMessage","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"loading-message","reflectToAttr":false,"docs":"","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"type","type":"\"chart\" | \"error\" | \"text\"","complexType":{"original":"\"chart\" | \"error\" | \"text\"","resolved":"\"chart\" | \"error\" | \"text\"","references":{}},"mutable":true,"attr":"type","reflectToAttr":false,"docs":"","docsTags":[],"default":"\"text\"","values":[{"type":"string","value":"chart"},{"type":"string","value":"error"},{"type":"string","value":"text"}],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise<this>","docs":""},"complexType":{"signature":"(): Promise<this>","parameters":[],"return":"Promise<this>","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise<this>","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisAssistantChatCardContent = document.querySelector(\"arcgis-assistant-chat-card-content\");\ndocument.body.append(arcgisAssistantChatCardContent);\nawait arcgisAssistantChatCardContent.componentOnReady();\nconsole.log(\"arcgis-assistant-chat-card-content is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"PublicLitElement\",\"module\":\"PublicLitElement\",\"package\":\"@arcgis/lumina\"}"}]}],"events":[],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/assistant/assistant-chat-entry/assistant-chat-entry.tsx","tag":"arcgis-assistant-chat-entry","overview":"","readme":"","usage":{},"docs":"","docsTags":[{"name":"internal"},{"name":"superclass","text":"{\"name\":\"PublicLitElement\",\"module\":\"PublicLitElement\",\"package\":\"@arcgis/lumina\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"awaitingResponse","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"awaiting-response","reflectToAttr":false,"docs":"","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"enterKeySubmits","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"enter-key-submits","reflectToAttr":false,"docs":"","docsTags":[],"default":"true","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"entryPlaceholder","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"entry-placeholder","reflectToAttr":false,"docs":"","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"inputValue","type":"string","complexType":{"original":"string","resolved":"string","references":{}},"mutable":true,"attr":"input-value","reflectToAttr":false,"docs":"","docsTags":[],"default":"\"\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"status","type":"\"error\" | \"ready\" | \"working\" | undefined","complexType":{"original":"\"error\" | \"ready\" | \"working\" | undefined","resolved":"\"error\" | \"ready\" | \"working\" | undefined","references":{}},"mutable":true,"attr":"status","reflectToAttr":false,"docs":"","docsTags":[],"values":[{"type":"string","value":"error"},{"type":"string","value":"ready"},{"type":"string","value":"working"}],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise<this>","docs":""},"complexType":{"signature":"(): Promise<this>","parameters":[],"return":"Promise<this>","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise<this>","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisAssistantChatEntry = document.querySelector(\"arcgis-assistant-chat-entry\");\ndocument.body.append(arcgisAssistantChatEntry);\nawait arcgisAssistantChatEntry.componentOnReady();\nconsole.log(\"arcgis-assistant-chat-entry is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"PublicLitElement\",\"module\":\"PublicLitElement\",\"package\":\"@arcgis/lumina\"}"}]}],"events":[{"event":"arcgisCancel","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"","docsTags":[]},{"event":"arcgisSubmit","detail":"string","bubbles":true,"complexType":{"original":"string","resolved":"string","references":{}},"cancelable":true,"composed":true,"docs":"","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/assistant/assistant-interrupt/assistant-interrupt.tsx","tag":"arcgis-assistant-interrupt","overview":"","readme":"","usage":{},"docs":"","docsTags":[{"name":"internal"},{"name":"superclass","text":"{\"name\":\"PublicLitElement\",\"module\":\"PublicLitElement\",\"package\":\"@arcgis/lumina\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"message","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"message","reflectToAttr":false,"docs":"","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"options","type":"string[] | undefined","complexType":{"original":"string[] | undefined","resolved":"string[] | undefined","references":{}},"mutable":true,"reflectToAttr":false,"docs":"","docsTags":[],"values":[],"optional":true,"required":false},{"name":"type","type":"\"boolean-choice\" | \"multi-select\" | \"single-select\" | \"text-input\"","complexType":{"original":"\"boolean-choice\" | \"multi-select\" | \"single-select\" | \"text-input\"","resolved":"\"boolean-choice\" | \"multi-select\" | \"single-select\" | \"text-input\"","references":{}},"mutable":true,"attr":"type","reflectToAttr":false,"docs":"","docsTags":[],"values":[{"type":"string","value":"boolean-choice"},{"type":"string","value":"multi-select"},{"type":"string","value":"single-select"},{"type":"string","value":"text-input"}],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise<this>","docs":""},"complexType":{"signature":"(): Promise<this>","parameters":[],"return":"Promise<this>","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise<this>","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisAssistantInterrupt = document.querySelector(\"arcgis-assistant-interrupt\");\ndocument.body.append(arcgisAssistantInterrupt);\nawait arcgisAssistantInterrupt.componentOnReady();\nconsole.log(\"arcgis-assistant-interrupt is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"PublicLitElement\",\"module\":\"PublicLitElement\",\"package\":\"@arcgis/lumina\"}"}]}],"events":[{"event":"arcgisCancel","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"","docsTags":[]},{"event":"arcgisSubmit","detail":"string[] | string","bubbles":true,"complexType":{"original":"string[] | string","resolved":"string[] | string","references":{}},"cancelable":true,"composed":true,"docs":"","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/assistant/assistant-shell/assistant-shell.tsx","tag":"arcgis-assistant-shell","overview":"","readme":"","usage":{},"docs":"","docsTags":[{"name":"internal"},{"name":"superclass","text":"{\"name\":\"PublicLitElement\",\"module\":\"PublicLitElement\",\"package\":\"@arcgis/lumina\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"awaitingResponse","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"awaiting-response","reflectToAttr":false,"docs":"","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"description","type":"string","complexType":{"original":"string","resolved":"string","references":{}},"mutable":true,"attr":"description","reflectToAttr":false,"docs":"","docsTags":[],"default":"\"\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"entryMessage","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"entry-message","reflectToAttr":false,"docs":"","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"entryMessageClosed","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"entry-message-closed","reflectToAttr":false,"docs":"","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"heading","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"heading","reflectToAttr":false,"docs":"","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"inputValue","type":"string","complexType":{"original":"string","resolved":"string","references":{}},"mutable":true,"attr":"input-value","reflectToAttr":false,"docs":"","docsTags":[],"default":"\"\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"loading","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"loading","reflectToAttr":false,"docs":"","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"status","type":"\"error\" | \"ready\" | \"working\" | undefined","complexType":{"original":"\"error\" | \"ready\" | \"working\" | undefined","resolved":"\"error\" | \"ready\" | \"working\" | undefined","references":{}},"mutable":true,"attr":"status","reflectToAttr":false,"docs":"","docsTags":[],"values":[{"type":"string","value":"error"},{"type":"string","value":"ready"},{"type":"string","value":"working"}],"optional":true,"required":false},{"name":"suggestedPrompts","type":"string[]","complexType":{"original":"string[]","resolved":"string[]","references":{}},"mutable":true,"reflectToAttr":false,"docs":"","docsTags":[],"values":[],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise<this>","docs":""},"complexType":{"signature":"(): Promise<this>","parameters":[],"return":"Promise<this>","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise<this>","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisAssistantShell = document.querySelector(\"arcgis-assistant-shell\");\ndocument.body.append(arcgisAssistantShell);\nawait arcgisAssistantShell.componentOnReady();\nconsole.log(\"arcgis-assistant-shell is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"PublicLitElement\",\"module\":\"PublicLitElement\",\"package\":\"@arcgis/lumina\"}"}]}],"events":[{"event":"arcgisCancel","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"","docsTags":[]},{"event":"arcgisSubmit","detail":"string","bubbles":true,"complexType":{"original":"string","resolved":"string","references":{}},"cancelable":true,"composed":true,"docs":"","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]}],"typeLibrary":{}}
1
+ {"timestamp":"2026-01-30T06:57:32","compiler":{"name":"@arcgis/lumina-compiler","version":"5.0.0-next.152","typescriptVersion":"5.9.3"},"components":[{"filePath":"src/components/assistant/assistant.tsx","tag":"arcgis-assistant","overview":"","readme":"","usage":{},"docs":"The ArcGIS Assistant component provides a chat-based natural language interface for interacting with\nmap data and services. This component relies on large language models to understand user prompts and\ngenerate both text and structured responses based on the user's intent and the context of the map.\n\nBy default, the `arcgis-assistant` component does not include any agents. You must register at least one\nagent for the assistant to function. You can register agents declaratively using any of the\navailable agent components, or you can register custom agents.\n\n## Register ArcGIS agents\n\nTo register ArcGIS agents declaratively, include one or more of the following agent components as children\nof the `arcgis-assistant` component. This can be done in HTML or programmatically using JavaScript.\n\n```html\n<arcgis-assistant>\n <arcgis-assistant-navigation-agent></arcgis-assistant-navigation-agent>\n <arcgis-assistant-data-exploration-agent></arcgis-assistant-data-exploration-agent>\n</arcgis-assistant>\n```\n\n```js\nconst assistant = document.querySelector(\"arcgis-assistant\");\nconst navigationAgent = document.createElement(\"arcgis-assistant-navigation-agent\");\nconst dataExplorationAgent = document.createElement(\"arcgis-assistant-data-exploration-agent\");\nassistant.appendChild(navigationAgent);\nassistant.appendChild(dataExplorationAgent);\n```\n\nTo learn more about this component, try out the [demo](#demo) below.","docsTags":[{"name":"since","text":"5.0"},{"name":"beta"},{"name":"see","text":"[arcgis-assistant-data-exploration-agent](https://developers.arcgis.com/javascript/latest/references/ai-components/components/arcgis-assistant-data-exploration-agent/)"},{"name":"see","text":"[arcgis-assistant-navigation-agent](https://developers.arcgis.com/javascript/latest/references/ai-components/components/arcgis-assistant-navigation-agent/)"},{"name":"superclass","text":"{\"name\":\"PublicLitElement\",\"module\":\"PublicLitElement\",\"package\":\"@arcgis/lumina\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"description","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"description","reflectToAttr":false,"docs":"The description text displayed below the heading in the assistant. This text provides additional\ncontext about the assistant's capabilities and how users can interact with it.","docsTags":[{"name":"example","text":"```html\n<arcgis-assistant description=\"Ask anything about your map data.\"></arcgis-assistant>\n```"},{"name":"example","text":"```js\nconst assistant = document.querySelector(\"arcgis-assistant\");\nassistant.description = \"Ask anything about your map data.\";\n```"}],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"entryMessage","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"entry-message","reflectToAttr":false,"docs":"The message to display when the assistant is first loaded.","docsTags":[{"name":"example","text":"```html\n<arcgis-assistant entry-message=\"Hello! How can I assist you with your map today?\"></arcgis-assistant>\n```"},{"name":"example","text":"```js\nconst assistant = document.querySelector(\"arcgis-assistant\");\nassistant.entryMessage = \"Hello! How can I assist you with your map today?\";\n```"}],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"heading","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"heading","reflectToAttr":false,"docs":"The heading text displayed at the top of the assistant. This name should be concise and\ndescriptive of the assistant's purpose.","docsTags":[{"name":"example","text":"```html\n<arcgis-assistant heading=\"Map Assistant\"></arcgis-assistant>\n```"},{"name":"example","text":"```js\nconst assistant = document.querySelector(\"arcgis-assistant\");\nassistant.heading = \"Map Assistant\";\n```"}],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"portal","type":"Portal","complexType":{"original":"Portal","resolved":"Portal","references":{"default":{"location":"import","path":"@arcgis/core/portal/Portal.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The portal used for authentication and making requests to the LLM via proxy requests.","docsTags":[{"name":"example","text":"```js\nconst assistant = document.querySelector(\"arcgis-assistant\");\nassistant.portal = new Portal({ url: \"https://www.arcgis.com\" });\n```"}],"values":[],"optional":true,"required":false},{"name":"referenceElement","type":"ArcgisMap | string | null","complexType":{"original":"ArcgisMap | string | null","resolved":"ArcgisMap | string | null","references":{"ArcgisMap":{"location":"import","path":"@arcgis/map-components/components/arcgis-map","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"The reference element to the map that provides context for the assistant and its agents. Currently,\nthis is only scoped to `arcgis-map` elements, but may be extended to support other elements in\nthe future.","docsTags":[{"name":"example","text":"```html\n<arcgis-map id=\"my-map\"></arcgis-map>\n<arcgis-assistant reference-element=\"#my-map\"></arcgis-assistant>\n```"}],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false},{"name":"suggestedPrompts","type":"string[]","complexType":{"original":"string[]","resolved":"string[]","references":{}},"mutable":true,"reflectToAttr":false,"docs":"Suggested prompts to display in the assistant on load. These are intended to help users get started\nwith common queries or actions.You should typically provide 2-3 suggested prompts that are\nrelevant to the context of the data being used and the capabilities of the registered agents.","docsTags":[{"name":"example","text":"```js\nconst assistant = document.querySelector(\"arcgis-assistant\");\nassistant.suggestedPrompts = [\n \"What city has the highest population?\",\n \"What is the highest point in this area?\"\n];\n```"}],"values":[],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise<this>","docs":""},"complexType":{"signature":"(): Promise<this>","parameters":[],"return":"Promise<this>","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise<this>","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisAssistant = document.querySelector(\"arcgis-assistant\");\ndocument.body.append(arcgisAssistant);\nawait arcgisAssistant.componentOnReady();\nconsole.log(\"arcgis-assistant is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"PublicLitElement\",\"module\":\"PublicLitElement\",\"package\":\"@arcgis/lumina\"}"}]}],"events":[],"styles":[],"slots":[{"name":"","docs":"This is the default slot"},{"name":"header-actions-end","docs":"Slot for adding actions to the end of the header."},{"name":"entry-message","docs":"Slot for adding a welcome or entry message on load."},{"name":"entry-actions-start","docs":"Slot for adding actions to the start of the entry area."},{"name":"footer-content","docs":"Slot for adding content to the footer."}],"parts":[],"listeners":[]},{"filePath":"src/components/assistant/assistant-agents/assistant-agent/assistant-agent.tsx","tag":"arcgis-assistant-agent","overview":"","readme":"","usage":{},"docs":"The Assistant Agent component is a generic wrapper for adding custom AI agents into the ArcGIS Assistant component. To define\na custom agent, you must be familiar with [LangGraph](https://docs.langchain.com/oss/javascript/langgraph/overview). Custom agents must\ninclude a StateGraph that defines the agent's graph and subgraphs.\n\n> Building custom agents can only be done using modern JavaScript/TypeScript tooling and cannot be done directly in HTML using\nCDN imports. Therefore, you must use a package manager like npm or yarn to install the required dependencies. Please refer to the\nCreating Custom Agents guide for more instructions.\n\nThis is an unrendered component that must be added as a child of the `arcgis-assistant` component in either HTML or JavaScript.\n\n```html\n<arcgis-assistant></arcgis-assistant>\n```\n\n```js\nconst myCustomAgent = {\n id: \"my-custom-agent\",\n name: \"My Custom Agent\",\n description: \"An agent that does custom things. Use this agent when users want to do custom things.\",\n createGraph: {\n // StateGraph definition using LangGraph\n },\n workspace: {\n // AnnotationRoot definition using LangGraph\n // relevant variables and context required by the agent\n },\n};\n\nconst assistant = document.querySelector(\"arcgis-assistant\");\nconst assistantAgent = document.createElement(\"arcgis-assistant-agent\");\n\nassistantAgent.agent = myCustomAgent;\nassistant.appendChild(assistantAgent);\n```","docsTags":[{"name":"since","text":"5.0"},{"name":"beta"},{"name":"see","text":"[arcgis-assistant](https://developers.arcgis.com/javascript/latest/references/ai-components/components/arcgis-assistant/)"},{"name":"see","text":"[LangGraph documentation](https://docs.langchain.com/oss/javascript/langgraph/overview)"},{"name":"superclass","text":"{\"name\":\"PublicLitElement\",\"module\":\"PublicLitElement\",\"package\":\"@arcgis/lumina\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"agent","type":"AgentRegistration","complexType":{"original":"AgentRegistration","resolved":"AgentRegistration","references":{"AgentRegistration":{"location":"import","path":"@arcgis/ai-orchestrator","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"The agent registration object that defines the AI agent's behavior and capabilities.\nThis must include a StateGraph definition (defined using\n[LangGraph](https://docs.langchain.com/oss/javascript/langgraph/overview)).\n\nThis is an agent defined in the client and can be invoked by the assistant within the browser to perform specific tasks\nusing functions defined in the client.\n\nSee the Creating Custom Agents guide for more instructions.","docsTags":[{"name":"required"},{"name":"see","text":"[LangGraph documentation](https://docs.langchain.com/oss/javascript/langgraph/overview)"},{"name":"example","text":"```js\n// An example graph that updates a component property and replies with a confirmation message\nconst myCustomGraph = () => {\n const graph = new StateGraph(myCustomState)\n .addNode(\"updateComponentProperty\", updateComponentProperty)\n .addNode(\"replyComponentPropertyUpdate\", replyComponentPropertyUpdate)\n .addEdge(START, \"updateComponentProperty\")\n .addEdge(\"updateComponentProperty\", \"replyComponentPropertyUpdate\")\n .addEdge(\"replyComponentPropertyUpdate\", END);\n\n return graph;\n};\n\nconst myCustomAgentState = Annotation.Root({\n // This is required to keep track of chat messages between the user and the agent\n messages: Annotation<ChatHistory>({\n reducer: messagesStateReducer,\n default: () => [],\n }),\n // Accumulates user-visible output across graph nodes\n outputMessage: Annotation<string>({\n reducer: (current = \"\", update) =>\n typeof update === \"string\" && update.trim()\n ? current\n ? `${current}\\n\\n${update}`\n : update\n : current,\n default: () => \"\",\n }),\n // Result of the UI action performed by the agent\n // This is a custom type defined by the application\n result: Annotation<UIActionResult | null>({\n reducer: (_current, update) => update ?? null,\n default: () => null,\n }),\n});\n\nconst myCustomAgent = {\n id: \"my-custom-agent\",\n name: \"My Custom Agent\",\n description: \"An agent that does custom things. Use this agent when users want to do custom things.\",\n createGraph: myCustomGraph,\n workspace: myCustomAgentState,\n};\n\nconst assistant = document.querySelector(\"arcgis-assistant\");\nconst assistantAgent = document.createElement(\"arcgis-assistant-agent\");\n\nassistantAgent.agent = myCustomAgent;\nassistant.appendChild(assistantAgent);\n```"}],"values":[],"optional":false,"required":true},{"name":"context","type":"TContext | undefined","complexType":{"original":"TContext | undefined","resolved":"TContext | undefined","references":{"TContext":{"location":"local","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"If the agent requires context, it can be provided via this property and accessed in the\nagent's graph nodes.","docsTags":[{"name":"example","text":"```js\nassistantAgent.context = {\n myData: {\n // custom context data for the agent\n },\n};\n```"}],"values":[],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise<this>","docs":""},"complexType":{"signature":"(): Promise<this>","parameters":[],"return":"Promise<this>","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise<this>","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisAssistantAgent = document.querySelector(\"arcgis-assistant-agent\");\ndocument.body.append(arcgisAssistantAgent);\nawait arcgisAssistantAgent.componentOnReady();\nconsole.log(\"arcgis-assistant-agent is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"PublicLitElement\",\"module\":\"PublicLitElement\",\"package\":\"@arcgis/lumina\"}"}]}],"events":[],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/assistant/assistant-agents/assistant-data-exploration-agent/assistant-data-exploration-agent.tsx","tag":"arcgis-assistant-data-exploration-agent","overview":"","readme":"","usage":{},"docs":"The Data Exploration Agent component enables the end user to query features, statistics, and spatial proximity\nof layer within a provided web map. Currently, this is only scoped to querying feature layers within\na 2D web map.\n\nThis is an unrendered component that must be added as a child of the `arcgis-assistant` component in either HTML or JavaScript.\n\n```html\n<arcgis-assistant>\n <arcgis-assistant-data-exploration-agent></arcgis-assistant-data-exploration-agent>\n</arcgis-assistant>\n```\n\n```js\nconst assistant = document.querySelector(\"arcgis-assistant\");\nconst dataExplorationAgent = document.createElement(\"arcgis-assistant-data-exploration-agent\");\nassistant.appendChild(dataExplorationAgent);\n```","docsTags":[{"name":"since","text":"5.0"},{"name":"beta"},{"name":"see","text":"[arcgis-assistant](https://developers.arcgis.com/javascript/latest/references/ai-components/components/arcgis-assistant/)"},{"name":"superclass","text":"{\"name\":\"PublicLitElement\",\"module\":\"PublicLitElement\",\"package\":\"@arcgis/lumina\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"referenceElement","type":"ArcgisMap | string | undefined","complexType":{"original":"ArcgisMap | string | undefined","resolved":"ArcgisMap | string | undefined","references":{"ArcgisMap":{"location":"import","path":"@arcgis/map-components/components/arcgis-map","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"A reference to the map element or its ID string used to resolve the MapView for this agent.\nIf not provided, the agent will attempt to find the closest parent `arcgis-map` element.","docsTags":[],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise<this>","docs":""},"complexType":{"signature":"(): Promise<this>","parameters":[],"return":"Promise<this>","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise<this>","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisAssistantDataExplorationAgent = document.querySelector(\"arcgis-assistant-data-exploration-agent\");\ndocument.body.append(arcgisAssistantDataExplorationAgent);\nawait arcgisAssistantDataExplorationAgent.componentOnReady();\nconsole.log(\"arcgis-assistant-data-exploration-agent is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"PublicLitElement\",\"module\":\"PublicLitElement\",\"package\":\"@arcgis/lumina\"}"}]}],"events":[],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/assistant/assistant-agents/assistant-layer-filter-agent/assistant-layer-filter-agent.tsx","tag":"arcgis-assistant-layer-filter-agent","overview":"","readme":"","usage":{},"docs":"","docsTags":[{"name":"internal"},{"name":"superclass","text":"{\"name\":\"PublicLitElement\",\"module\":\"PublicLitElement\",\"package\":\"@arcgis/lumina\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"referenceElement","type":"ArcgisMap | string | undefined","complexType":{"original":"ArcgisMap | string | undefined","resolved":"ArcgisMap | string | undefined","references":{"ArcgisMap":{"location":"import","path":"@arcgis/map-components/components/arcgis-map","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"","docsTags":[],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise<this>","docs":""},"complexType":{"signature":"(): Promise<this>","parameters":[],"return":"Promise<this>","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise<this>","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisAssistantLayerFilterAgent = document.querySelector(\"arcgis-assistant-layer-filter-agent\");\ndocument.body.append(arcgisAssistantLayerFilterAgent);\nawait arcgisAssistantLayerFilterAgent.componentOnReady();\nconsole.log(\"arcgis-assistant-layer-filter-agent is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"PublicLitElement\",\"module\":\"PublicLitElement\",\"package\":\"@arcgis/lumina\"}"}]}],"events":[],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/assistant/assistant-agents/assistant-layer-query-agent/assistant-layer-query-agent.tsx","tag":"arcgis-assistant-layer-query-agent","overview":"","readme":"","usage":{},"docs":"","docsTags":[{"name":"internal"},{"name":"superclass","text":"{\"name\":\"PublicLitElement\",\"module\":\"PublicLitElement\",\"package\":\"@arcgis/lumina\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"referenceElement","type":"ArcgisMap | string | undefined","complexType":{"original":"ArcgisMap | string | undefined","resolved":"ArcgisMap | string | undefined","references":{"ArcgisMap":{"location":"import","path":"@arcgis/map-components/components/arcgis-map","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"","docsTags":[],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise<this>","docs":""},"complexType":{"signature":"(): Promise<this>","parameters":[],"return":"Promise<this>","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise<this>","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisAssistantLayerQueryAgent = document.querySelector(\"arcgis-assistant-layer-query-agent\");\ndocument.body.append(arcgisAssistantLayerQueryAgent);\nawait arcgisAssistantLayerQueryAgent.componentOnReady();\nconsole.log(\"arcgis-assistant-layer-query-agent is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"PublicLitElement\",\"module\":\"PublicLitElement\",\"package\":\"@arcgis/lumina\"}"}]}],"events":[],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/assistant/assistant-agents/assistant-layer-styling-agent/assistant-layer-styling-agent.tsx","tag":"arcgis-assistant-layer-styling-agent","overview":"","readme":"","usage":{},"docs":"","docsTags":[{"name":"internal"},{"name":"superclass","text":"{\"name\":\"PublicLitElement\",\"module\":\"PublicLitElement\",\"package\":\"@arcgis/lumina\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"referenceElement","type":"ArcgisMap | string | undefined","complexType":{"original":"ArcgisMap | string | undefined","resolved":"ArcgisMap | string | undefined","references":{"ArcgisMap":{"location":"import","path":"@arcgis/map-components/components/arcgis-map","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"","docsTags":[],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise<this>","docs":""},"complexType":{"signature":"(): Promise<this>","parameters":[],"return":"Promise<this>","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise<this>","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisAssistantLayerStylingAgent = document.querySelector(\"arcgis-assistant-layer-styling-agent\");\ndocument.body.append(arcgisAssistantLayerStylingAgent);\nawait arcgisAssistantLayerStylingAgent.componentOnReady();\nconsole.log(\"arcgis-assistant-layer-styling-agent is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"PublicLitElement\",\"module\":\"PublicLitElement\",\"package\":\"@arcgis/lumina\"}"}]}],"events":[],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/assistant/assistant-agents/assistant-navigation-agent/assistant-navigation-agent.tsx","tag":"arcgis-assistant-navigation-agent","overview":"","readme":"","usage":{},"docs":"The Navigation Agent component enables the end user to navigate to different areas of a web map.\nIt allows you to type in a place name, address, or layer title to navigate to the desired location.\nCurrently, this is only scoped to navigation within a 2D map view.\n\nThis is an unrendered component that must be added as a child of the `arcgis-assistant` component in either HTML or JavaScript.\n\n```html\n<arcgis-assistant>\n <arcgis-assistant-navigation-agent></arcgis-assistant-navigation-agent>\n</arcgis-assistant>\n```\n\n```js\nconst assistant = document.querySelector(\"arcgis-assistant\");\nconst navigationAgent = document.createElement(\"arcgis-assistant-navigation-agent\");\nassistant.appendChild(navigationAgent);\n```","docsTags":[{"name":"since","text":"5.0"},{"name":"beta"},{"name":"see","text":"[arcgis-assistant](https://developers.arcgis.com/javascript/latest/references/ai-components/components/arcgis-assistant/)"},{"name":"superclass","text":"{\"name\":\"PublicLitElement\",\"module\":\"PublicLitElement\",\"package\":\"@arcgis/lumina\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"referenceElement","type":"ArcgisMap | string | undefined","complexType":{"original":"ArcgisMap | string | undefined","resolved":"ArcgisMap | string | undefined","references":{"ArcgisMap":{"location":"import","path":"@arcgis/map-components/components/arcgis-map","id":"notImplemented"}}},"mutable":true,"attr":"reference-element","reflectToAttr":false,"docs":"A reference to the map element or its ID string used to resolve the MapView for this agent.\nIf not provided, the agent will attempt to find the closest parent `arcgis-map` element.","docsTags":[],"values":[{"type":"string"},{"type":"object"}],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise<this>","docs":""},"complexType":{"signature":"(): Promise<this>","parameters":[],"return":"Promise<this>","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise<this>","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisAssistantNavigationAgent = document.querySelector(\"arcgis-assistant-navigation-agent\");\ndocument.body.append(arcgisAssistantNavigationAgent);\nawait arcgisAssistantNavigationAgent.componentOnReady();\nconsole.log(\"arcgis-assistant-navigation-agent is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"PublicLitElement\",\"module\":\"PublicLitElement\",\"package\":\"@arcgis/lumina\"}"}]}],"events":[],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/assistant/assistant-chat/assistant-chat.tsx","tag":"arcgis-assistant-chat","overview":"","readme":"","usage":{},"docs":"","docsTags":[{"name":"internal"},{"name":"superclass","text":"{\"name\":\"PublicLitElement\",\"module\":\"PublicLitElement\",\"package\":\"@arcgis/lumina\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"loading","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"loading","reflectToAttr":false,"docs":"","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"loadingMessage","type":"string","complexType":{"original":"string","resolved":"string","references":{}},"mutable":true,"attr":"loading-message","reflectToAttr":false,"docs":"","docsTags":[],"default":"\"\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"messages","type":"Collection<{\n type: \"prompt\" | \"response\";\n content?: string;\n log?: string;\n error?: string;\n}>","complexType":{"original":"Collection<{\n type: \"prompt\" | \"response\";\n content?: string;\n log?: string;\n error?: string;\n}>","resolved":"Collection<{\n type: \"prompt\" | \"response\";\n content?: string;\n log?: string;\n error?: string;\n}>","references":{"default":{"location":"import","path":"@arcgis/core/core/Collection.js","id":"notImplemented"}}},"mutable":true,"reflectToAttr":false,"docs":"","docsTags":[],"values":[],"optional":true,"required":false},{"name":"user","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"user","reflectToAttr":false,"docs":"","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise<this>","docs":""},"complexType":{"signature":"(): Promise<this>","parameters":[],"return":"Promise<this>","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise<this>","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisAssistantChat = document.querySelector(\"arcgis-assistant-chat\");\ndocument.body.append(arcgisAssistantChat);\nawait arcgisAssistantChat.componentOnReady();\nconsole.log(\"arcgis-assistant-chat is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"PublicLitElement\",\"module\":\"PublicLitElement\",\"package\":\"@arcgis/lumina\"}"}]}],"events":[],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/assistant/assistant-chat-card/assistant-chat-card.tsx","tag":"arcgis-assistant-chat-card","overview":"","readme":"","usage":{},"docs":"","docsTags":[{"name":"internal"},{"name":"superclass","text":"{\"name\":\"PublicLitElement\",\"module\":\"PublicLitElement\",\"package\":\"@arcgis/lumina\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"content","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"content","reflectToAttr":false,"docs":"","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"error","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"error","reflectToAttr":false,"docs":"","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"feedbackDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"feedback-disabled","reflectToAttr":false,"docs":"","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"loading","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"loading","reflectToAttr":false,"docs":"","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"loadingMessage","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"loading-message","reflectToAttr":false,"docs":"","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"log","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"log","reflectToAttr":false,"docs":"","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"timestampDisabled","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"timestamp-disabled","reflectToAttr":false,"docs":"","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"type","type":"\"prompt\" | \"response\"","complexType":{"original":"\"prompt\" | \"response\"","resolved":"\"prompt\" | \"response\"","references":{}},"mutable":true,"attr":"type","reflectToAttr":false,"docs":"","docsTags":[],"default":"\"prompt\"","values":[{"type":"string","value":"prompt"},{"type":"string","value":"response"}],"optional":true,"required":false},{"name":"user","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"user","reflectToAttr":false,"docs":"","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise<this>","docs":""},"complexType":{"signature":"(): Promise<this>","parameters":[],"return":"Promise<this>","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise<this>","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisAssistantChatCard = document.querySelector(\"arcgis-assistant-chat-card\");\ndocument.body.append(arcgisAssistantChatCard);\nawait arcgisAssistantChatCard.componentOnReady();\nconsole.log(\"arcgis-assistant-chat-card is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"PublicLitElement\",\"module\":\"PublicLitElement\",\"package\":\"@arcgis/lumina\"}"}]}],"events":[],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/assistant/assistant-chat-card-content/assistant-chat-card-content.tsx","tag":"arcgis-assistant-chat-card-content","overview":"","readme":"","usage":{},"docs":"","docsTags":[{"name":"internal"},{"name":"superclass","text":"{\"name\":\"PublicLitElement\",\"module\":\"PublicLitElement\",\"package\":\"@arcgis/lumina\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"content","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"content","reflectToAttr":false,"docs":"","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"loading","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"loading","reflectToAttr":false,"docs":"","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"loadingMessage","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"loading-message","reflectToAttr":false,"docs":"","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"type","type":"\"chart\" | \"error\" | \"text\"","complexType":{"original":"\"chart\" | \"error\" | \"text\"","resolved":"\"chart\" | \"error\" | \"text\"","references":{}},"mutable":true,"attr":"type","reflectToAttr":false,"docs":"","docsTags":[],"default":"\"text\"","values":[{"type":"string","value":"chart"},{"type":"string","value":"error"},{"type":"string","value":"text"}],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise<this>","docs":""},"complexType":{"signature":"(): Promise<this>","parameters":[],"return":"Promise<this>","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise<this>","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisAssistantChatCardContent = document.querySelector(\"arcgis-assistant-chat-card-content\");\ndocument.body.append(arcgisAssistantChatCardContent);\nawait arcgisAssistantChatCardContent.componentOnReady();\nconsole.log(\"arcgis-assistant-chat-card-content is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"PublicLitElement\",\"module\":\"PublicLitElement\",\"package\":\"@arcgis/lumina\"}"}]}],"events":[],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/assistant/assistant-chat-entry/assistant-chat-entry.tsx","tag":"arcgis-assistant-chat-entry","overview":"","readme":"","usage":{},"docs":"","docsTags":[{"name":"internal"},{"name":"superclass","text":"{\"name\":\"PublicLitElement\",\"module\":\"PublicLitElement\",\"package\":\"@arcgis/lumina\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"awaitingResponse","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"awaiting-response","reflectToAttr":false,"docs":"","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"enterKeySubmits","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"enter-key-submits","reflectToAttr":false,"docs":"","docsTags":[],"default":"true","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"entryPlaceholder","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"entry-placeholder","reflectToAttr":false,"docs":"","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"inputValue","type":"string","complexType":{"original":"string","resolved":"string","references":{}},"mutable":true,"attr":"input-value","reflectToAttr":false,"docs":"","docsTags":[],"default":"\"\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"status","type":"\"error\" | \"ready\" | \"working\" | undefined","complexType":{"original":"\"error\" | \"ready\" | \"working\" | undefined","resolved":"\"error\" | \"ready\" | \"working\" | undefined","references":{}},"mutable":true,"attr":"status","reflectToAttr":false,"docs":"","docsTags":[],"values":[{"type":"string","value":"error"},{"type":"string","value":"ready"},{"type":"string","value":"working"}],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise<this>","docs":""},"complexType":{"signature":"(): Promise<this>","parameters":[],"return":"Promise<this>","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise<this>","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisAssistantChatEntry = document.querySelector(\"arcgis-assistant-chat-entry\");\ndocument.body.append(arcgisAssistantChatEntry);\nawait arcgisAssistantChatEntry.componentOnReady();\nconsole.log(\"arcgis-assistant-chat-entry is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"PublicLitElement\",\"module\":\"PublicLitElement\",\"package\":\"@arcgis/lumina\"}"}]}],"events":[{"event":"arcgisCancel","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"","docsTags":[]},{"event":"arcgisSubmit","detail":"string","bubbles":true,"complexType":{"original":"string","resolved":"string","references":{}},"cancelable":true,"composed":true,"docs":"","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/assistant/assistant-interrupt/assistant-interrupt.tsx","tag":"arcgis-assistant-interrupt","overview":"","readme":"","usage":{},"docs":"","docsTags":[{"name":"internal"},{"name":"superclass","text":"{\"name\":\"PublicLitElement\",\"module\":\"PublicLitElement\",\"package\":\"@arcgis/lumina\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"message","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"message","reflectToAttr":false,"docs":"","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"options","type":"string[] | undefined","complexType":{"original":"string[] | undefined","resolved":"string[] | undefined","references":{}},"mutable":true,"reflectToAttr":false,"docs":"","docsTags":[],"values":[],"optional":true,"required":false},{"name":"type","type":"\"boolean-choice\" | \"multi-select\" | \"single-select\" | \"text-input\"","complexType":{"original":"\"boolean-choice\" | \"multi-select\" | \"single-select\" | \"text-input\"","resolved":"\"boolean-choice\" | \"multi-select\" | \"single-select\" | \"text-input\"","references":{}},"mutable":true,"attr":"type","reflectToAttr":false,"docs":"","docsTags":[],"values":[{"type":"string","value":"boolean-choice"},{"type":"string","value":"multi-select"},{"type":"string","value":"single-select"},{"type":"string","value":"text-input"}],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise<this>","docs":""},"complexType":{"signature":"(): Promise<this>","parameters":[],"return":"Promise<this>","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise<this>","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisAssistantInterrupt = document.querySelector(\"arcgis-assistant-interrupt\");\ndocument.body.append(arcgisAssistantInterrupt);\nawait arcgisAssistantInterrupt.componentOnReady();\nconsole.log(\"arcgis-assistant-interrupt is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"PublicLitElement\",\"module\":\"PublicLitElement\",\"package\":\"@arcgis/lumina\"}"}]}],"events":[{"event":"arcgisCancel","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"","docsTags":[]},{"event":"arcgisSubmit","detail":"string[] | string","bubbles":true,"complexType":{"original":"string[] | string","resolved":"string[] | string","references":{}},"cancelable":true,"composed":true,"docs":"","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]},{"filePath":"src/components/assistant/assistant-shell/assistant-shell.tsx","tag":"arcgis-assistant-shell","overview":"","readme":"","usage":{},"docs":"","docsTags":[{"name":"internal"},{"name":"superclass","text":"{\"name\":\"PublicLitElement\",\"module\":\"PublicLitElement\",\"package\":\"@arcgis/lumina\"}"}],"encapsulation":"shadow","dependents":[],"dependencies":[],"dependencyGraph":{},"props":[{"name":"awaitingResponse","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"awaiting-response","reflectToAttr":false,"docs":"","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"description","type":"string","complexType":{"original":"string","resolved":"string","references":{}},"mutable":true,"attr":"description","reflectToAttr":false,"docs":"","docsTags":[],"default":"\"\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"entryMessage","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"entry-message","reflectToAttr":false,"docs":"","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"entryMessageClosed","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"entry-message-closed","reflectToAttr":false,"docs":"","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"heading","type":"string | undefined","complexType":{"original":"string | undefined","resolved":"string | undefined","references":{}},"mutable":true,"attr":"heading","reflectToAttr":false,"docs":"","docsTags":[],"values":[{"type":"string"}],"optional":true,"required":false},{"name":"inputValue","type":"string","complexType":{"original":"string","resolved":"string","references":{}},"mutable":true,"attr":"input-value","reflectToAttr":false,"docs":"","docsTags":[],"default":"\"\"","values":[{"type":"string"}],"optional":true,"required":false},{"name":"loading","type":"boolean","complexType":{"original":"boolean","resolved":"boolean","references":{}},"mutable":true,"attr":"loading","reflectToAttr":false,"docs":"","docsTags":[],"default":"false","values":[{"type":"boolean"}],"optional":true,"required":false},{"name":"status","type":"\"error\" | \"ready\" | \"working\" | undefined","complexType":{"original":"\"error\" | \"ready\" | \"working\" | undefined","resolved":"\"error\" | \"ready\" | \"working\" | undefined","references":{}},"mutable":true,"attr":"status","reflectToAttr":false,"docs":"","docsTags":[],"values":[{"type":"string","value":"error"},{"type":"string","value":"ready"},{"type":"string","value":"working"}],"optional":true,"required":false},{"name":"suggestedPrompts","type":"string[]","complexType":{"original":"string[]","resolved":"string[]","references":{}},"mutable":true,"reflectToAttr":false,"docs":"","docsTags":[],"values":[],"optional":true,"required":false}],"methods":[{"name":"componentOnReady","returns":{"type":"Promise<this>","docs":""},"complexType":{"signature":"(): Promise<this>","parameters":[],"return":"Promise<this>","references":{"Promise":{"location":"import","path":"typescript/lib/lib.es5.d.ts","id":"notImplemented"}}},"signature":"componentOnReady(): Promise<this>","parameters":[],"docs":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisAssistantShell = document.querySelector(\"arcgis-assistant-shell\");\ndocument.body.append(arcgisAssistantShell);\nawait arcgisAssistantShell.componentOnReady();\nconsole.log(\"arcgis-assistant-shell is ready to go!\");\n```"},{"name":"inheritedFrom","text":"{\"name\":\"PublicLitElement\",\"module\":\"PublicLitElement\",\"package\":\"@arcgis/lumina\"}"}]}],"events":[{"event":"arcgisCancel","detail":"void","bubbles":true,"complexType":{"original":"void","resolved":"void","references":{}},"cancelable":true,"composed":true,"docs":"","docsTags":[]},{"event":"arcgisSubmit","detail":"string","bubbles":true,"complexType":{"original":"string","resolved":"string","references":{}},"cancelable":true,"composed":true,"docs":"","docsTags":[]}],"styles":[],"slots":[],"parts":[],"listeners":[]}],"typeLibrary":{}}
@@ -1 +1 @@
1
- {"$schema":"https://raw.githubusercontent.com/microsoft/vscode-html-languageservice/main/docs/customData.schema.json","version":1.1,"tags":[{"name":"arcgis-assistant","description":"The ArcGIS Assistant component provides a chat-based natural language interface for interacting with\nmap data and services. This component relies on large language models to understand user prompts and\ngenerate both text and structured responses based on the user's intent and the context of the map.\n\nBy default, the `arcgis-assistant` component does not include any agents. You must register at least one\nagent for the assistant to function. You can register agents declaratively using any of the\navailable agent components, or you can register custom agents.\n\n## Register ArcGIS agents\n\nTo register ArcGIS agents declaratively, include one or more of the following agent components as children\nof the `arcgis-assistant` component. This can be done in HTML or programmatically using JavaScript.\n\n```html\n<arcgis-assistant>\n <arcgis-assistant-navigation-agent></arcgis-assistant-navigation-agent>\n <arcgis-assistant-data-exploration-agent></arcgis-assistant-data-exploration-agent>\n</arcgis-assistant>\n```\n\n```js\nconst assistant = document.querySelector(\"arcgis-assistant\");\nconst navigationAgent = document.createElement(\"arcgis-assistant-navigation-agent\");\nconst dataExplorationAgent = document.createElement(\"arcgis-assistant-data-exploration-agent\");\nassistant.appendChild(navigationAgent);\nassistant.appendChild(dataExplorationAgent);\n```\n\nTo learn more about this component, try out the [demo](#demo) below.\n--\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n\n### Slots\n- _default_ - This is the default slot\n- **header-actions-end** - Slot for adding actions to the end of the header.\n- **entry-message** - Slot for adding a welcome or entry message on load.\n- **entry-actions-start** - Slot for adding actions to the start of the entry area.\n- **footer-content** - Slot for adding content to the footer.","attributes":[{"name":"description","description":"The description text displayed below the heading in the assistant. This text provides additional\ncontext about the assistant's capabilities and how users can interact with it.","values":[]},{"name":"entry-message","description":"The message to display when the assistant is first loaded.","values":[]},{"name":"heading","description":"The heading text displayed at the top of the assistant. This name should be concise and\ndescriptive of the assistant's purpose.","values":[]},{"name":"reference-element","description":"The reference element to the map that provides context for the assistant and its agents. Currently,\nthis is only scoped to `arcgis-map` elements, but may be extended to support other elements in\nthe future.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/ai-components/arcgis-assistant/"},{"name":"Assistant Intro\nIntroduction to the Assistant component.","url":"https://developers.arcgis.com/javascript/latest/storybook/ai-components/?path=/story/arcgis-assistant--demo&singleStory=true"}]},{"name":"arcgis-assistant-agent","description":"The Assistant Agent component is a generic wrapper for adding custom AI agents into the ArcGIS Assistant component. To define\na custom agent, you must be familiar with [LangGraph](https://docs.langchain.com/oss/javascript/langgraph/overview). Custom agents must\ninclude a StateGraph that defines the agent's graph and subgraphs.\n\n> Building custom agents can only be done using modern JavaScript/TypeScript tooling and cannot be done directly in HTML using\nCDN imports. Therefore, you must use a package manager like npm or yarn to install the required dependencies. Please refer to the\nCreating Custom Agents guide for more instructions.\n\nThis is an unrendered component that must be added as a child of the `arcgis-assistant` component in either HTML or JavaScript.\n\n```html\n<arcgis-assistant></arcgis-assistant>\n```\n\n```js\nconst myCustomAgent = {\n id: \"my-custom-agent\",\n name: \"My Custom Agent\",\n description: \"An agent that does custom things. Use this agent when users want to do custom things.\",\n createGraph: {\n // StateGraph definition using LangGraph\n },\n workspace: {\n // AnnotationRoot definition using LangGraph\n // relevant variables and context required by the agent\n },\n};\n\nconst assistant = document.querySelector(\"arcgis-assistant\");\nconst assistantAgent = document.createElement(\"arcgis-assistant-agent\");\n\nassistantAgent.agent = myCustomAgent;\nassistant.appendChild(assistantAgent);\n```\n--\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","attributes":[],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/ai-components/arcgis-assistant-agent/"},{"name":"Custom Agent","url":"https://developers.arcgis.com/javascript/latest/storybook/ai-components/?path=/story/arcgis-assistant-agent--demo&singleStory=true"}]},{"name":"arcgis-assistant-data-exploration-agent","description":"The Data Exploration Agent component enables the end user to query features, statistics, and spatial proximity\nof layer within a provided web map. Currently, this is only scoped to querying feature layers within\na 2D web map.\n\nThis is an unrendered component that must be added as a child of the `arcgis-assistant` component in either HTML or JavaScript.\n\n```html\n<arcgis-assistant>\n <arcgis-assistant-data-exploration-agent></arcgis-assistant-data-exploration-agent>\n</arcgis-assistant>\n```\n\n```js\nconst assistant = document.querySelector(\"arcgis-assistant\");\nconst dataExplorationAgent = document.createElement(\"arcgis-assistant-data-exploration-agent\");\nassistant.appendChild(dataExplorationAgent);\n```\n--\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","attributes":[{"name":"reference-element","description":"A reference to the map element or its ID string used to resolve the MapView for this agent.\nIf not provided, the agent will attempt to find the closest parent `arcgis-map` element.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/ai-components/arcgis-assistant-data-exploration-agent/"},{"name":"Data Exploration Agent","url":"https://developers.arcgis.com/javascript/latest/storybook/ai-components/?path=/story/arcgis-assistant-data-exploration-agent--demo&singleStory=true"}]},{"name":"arcgis-assistant-layer-filter-agent","description":"### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","attributes":[{"name":"reference-element","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/ai-components/arcgis-assistant-layer-filter-agent/"}]},{"name":"arcgis-assistant-layer-query-agent","description":"### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","attributes":[{"name":"reference-element","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/ai-components/arcgis-assistant-layer-query-agent/"}]},{"name":"arcgis-assistant-layer-styling-agent","description":"### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","attributes":[{"name":"reference-element","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/ai-components/arcgis-assistant-layer-styling-agent/"}]},{"name":"arcgis-assistant-navigation-agent","description":"The Navigation Agent component enables the end user to navigate to different areas of a web map.\nIt allows you to type in a place name, address, or layer title to navigate to the desired location.\nCurrently, this is only scoped to navigation within a 2D map view.\n\nThis is an unrendered component that must be added as a child of the `arcgis-assistant` component in either HTML or JavaScript.\n\n```html\n<arcgis-assistant>\n <arcgis-assistant-navigation-agent></arcgis-assistant-navigation-agent>\n</arcgis-assistant>\n```\n\n```js\nconst assistant = document.querySelector(\"arcgis-assistant\");\nconst navigationAgent = document.createElement(\"arcgis-assistant-navigation-agent\");\nassistant.appendChild(navigationAgent);\n```\n--\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","attributes":[{"name":"reference-element","description":"A reference to the map element or its ID string used to resolve the MapView for this agent.\nIf not provided, the agent will attempt to find the closest parent `arcgis-map` element.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/ai-components/arcgis-assistant-navigation-agent/"},{"name":"Navigation Agent","url":"https://developers.arcgis.com/javascript/latest/storybook/ai-components/?path=/story/arcgis-assistant-navigation-agent--demo&singleStory=true"}]},{"name":"arcgis-assistant-chat","description":"### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","attributes":[{"name":"loading","values":[]},{"name":"loading-message","values":[]},{"name":"user","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/ai-components/arcgis-assistant-chat/"}]},{"name":"arcgis-assistant-chat-card","description":"### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","attributes":[{"name":"content","values":[]},{"name":"error","values":[]},{"name":"feedback-disabled","values":[]},{"name":"loading","values":[]},{"name":"loading-message","values":[]},{"name":"log","values":[]},{"name":"timestamp-disabled","values":[]},{"name":"type","values":[{"name":"prompt"},{"name":"response"}]},{"name":"user","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/ai-components/arcgis-assistant-chat-card/"}]},{"name":"arcgis-assistant-chat-card-content","description":"### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","attributes":[{"name":"content","values":[]},{"name":"loading","values":[]},{"name":"loading-message","values":[]},{"name":"type","values":[{"name":"chart"},{"name":"error"},{"name":"text"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/ai-components/arcgis-assistant-chat-card-content/"}]},{"name":"arcgis-assistant-chat-entry","description":"### Events\n- **arcgisCancel**\n- **arcgisSubmit**\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","attributes":[{"name":"awaiting-response","values":[]},{"name":"enter-key-submits","values":[]},{"name":"entry-placeholder","values":[]},{"name":"input-value","values":[]},{"name":"status","values":[{"name":"error"},{"name":"ready"},{"name":"working"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/ai-components/arcgis-assistant-chat-entry/"}]},{"name":"arcgis-assistant-interrupt","description":"### Events\n- **arcgisCancel**\n- **arcgisSubmit**\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","attributes":[{"name":"message","values":[]},{"name":"type","values":[{"name":"boolean-choice"},{"name":"multi-select"},{"name":"single-select"},{"name":"text-input"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/ai-components/arcgis-assistant-interrupt/"}]},{"name":"arcgis-assistant-shell","description":"### Events\n- **arcgisCancel**\n- **arcgisSubmit**\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","attributes":[{"name":"awaiting-response","values":[]},{"name":"description","values":[]},{"name":"entry-message","values":[]},{"name":"entry-message-closed","values":[]},{"name":"heading","values":[]},{"name":"input-value","values":[]},{"name":"loading","values":[]},{"name":"status","values":[{"name":"error"},{"name":"ready"},{"name":"working"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/ai-components/arcgis-assistant-shell/"}]}]}
1
+ {"$schema":"https://raw.githubusercontent.com/microsoft/vscode-html-languageservice/main/docs/customData.schema.json","version":1.1,"tags":[{"name":"arcgis-assistant","description":"The ArcGIS Assistant component provides a chat-based natural language interface for interacting with\nmap data and services. This component relies on large language models to understand user prompts and\ngenerate both text and structured responses based on the user's intent and the context of the map.\n\nBy default, the `arcgis-assistant` component does not include any agents. You must register at least one\nagent for the assistant to function. You can register agents declaratively using any of the\navailable agent components, or you can register custom agents.\n\n## Register ArcGIS agents\n\nTo register ArcGIS agents declaratively, include one or more of the following agent components as children\nof the `arcgis-assistant` component. This can be done in HTML or programmatically using JavaScript.\n\n```html\n<arcgis-assistant>\n <arcgis-assistant-navigation-agent></arcgis-assistant-navigation-agent>\n <arcgis-assistant-data-exploration-agent></arcgis-assistant-data-exploration-agent>\n</arcgis-assistant>\n```\n\n```js\nconst assistant = document.querySelector(\"arcgis-assistant\");\nconst navigationAgent = document.createElement(\"arcgis-assistant-navigation-agent\");\nconst dataExplorationAgent = document.createElement(\"arcgis-assistant-data-exploration-agent\");\nassistant.appendChild(navigationAgent);\nassistant.appendChild(dataExplorationAgent);\n```\n\nTo learn more about this component, try out the [demo](#demo) below.\n--\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n\n### Slots\n- _default_ - This is the default slot\n- **header-actions-end** - Slot for adding actions to the end of the header.\n- **entry-message** - Slot for adding a welcome or entry message on load.\n- **entry-actions-start** - Slot for adding actions to the start of the entry area.\n- **footer-content** - Slot for adding content to the footer.","attributes":[{"name":"description","description":"The description text displayed below the heading in the assistant. This text provides additional\ncontext about the assistant's capabilities and how users can interact with it.","values":[]},{"name":"entry-message","description":"The message to display when the assistant is first loaded.","values":[]},{"name":"heading","description":"The heading text displayed at the top of the assistant. This name should be concise and\ndescriptive of the assistant's purpose.","values":[]},{"name":"reference-element","description":"The reference element to the map that provides context for the assistant and its agents. Currently,\nthis is only scoped to `arcgis-map` elements, but may be extended to support other elements in\nthe future.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/ai-components/components/arcgis-assistant/"},{"name":"Assistant Intro\nIntroduction to the Assistant component.","url":"https://developers.arcgis.com/javascript/latest/storybook/ai-components/?path=/story/arcgis-assistant--demo&singleStory=true"}]},{"name":"arcgis-assistant-agent","description":"The Assistant Agent component is a generic wrapper for adding custom AI agents into the ArcGIS Assistant component. To define\na custom agent, you must be familiar with [LangGraph](https://docs.langchain.com/oss/javascript/langgraph/overview). Custom agents must\ninclude a StateGraph that defines the agent's graph and subgraphs.\n\n> Building custom agents can only be done using modern JavaScript/TypeScript tooling and cannot be done directly in HTML using\nCDN imports. Therefore, you must use a package manager like npm or yarn to install the required dependencies. Please refer to the\nCreating Custom Agents guide for more instructions.\n\nThis is an unrendered component that must be added as a child of the `arcgis-assistant` component in either HTML or JavaScript.\n\n```html\n<arcgis-assistant></arcgis-assistant>\n```\n\n```js\nconst myCustomAgent = {\n id: \"my-custom-agent\",\n name: \"My Custom Agent\",\n description: \"An agent that does custom things. Use this agent when users want to do custom things.\",\n createGraph: {\n // StateGraph definition using LangGraph\n },\n workspace: {\n // AnnotationRoot definition using LangGraph\n // relevant variables and context required by the agent\n },\n};\n\nconst assistant = document.querySelector(\"arcgis-assistant\");\nconst assistantAgent = document.createElement(\"arcgis-assistant-agent\");\n\nassistantAgent.agent = myCustomAgent;\nassistant.appendChild(assistantAgent);\n```\n--\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","attributes":[],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/ai-components/components/arcgis-assistant-agent/"},{"name":"Custom Agent","url":"https://developers.arcgis.com/javascript/latest/storybook/ai-components/?path=/story/arcgis-assistant-agent--demo&singleStory=true"}]},{"name":"arcgis-assistant-data-exploration-agent","description":"The Data Exploration Agent component enables the end user to query features, statistics, and spatial proximity\nof layer within a provided web map. Currently, this is only scoped to querying feature layers within\na 2D web map.\n\nThis is an unrendered component that must be added as a child of the `arcgis-assistant` component in either HTML or JavaScript.\n\n```html\n<arcgis-assistant>\n <arcgis-assistant-data-exploration-agent></arcgis-assistant-data-exploration-agent>\n</arcgis-assistant>\n```\n\n```js\nconst assistant = document.querySelector(\"arcgis-assistant\");\nconst dataExplorationAgent = document.createElement(\"arcgis-assistant-data-exploration-agent\");\nassistant.appendChild(dataExplorationAgent);\n```\n--\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","attributes":[{"name":"reference-element","description":"A reference to the map element or its ID string used to resolve the MapView for this agent.\nIf not provided, the agent will attempt to find the closest parent `arcgis-map` element.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/ai-components/components/arcgis-assistant-data-exploration-agent/"},{"name":"Data Exploration Agent","url":"https://developers.arcgis.com/javascript/latest/storybook/ai-components/?path=/story/arcgis-assistant-data-exploration-agent--demo&singleStory=true"}]},{"name":"arcgis-assistant-layer-filter-agent","description":"### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","attributes":[{"name":"reference-element","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/ai-components/components/arcgis-assistant-layer-filter-agent/"}]},{"name":"arcgis-assistant-layer-query-agent","description":"### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","attributes":[{"name":"reference-element","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/ai-components/components/arcgis-assistant-layer-query-agent/"}]},{"name":"arcgis-assistant-layer-styling-agent","description":"### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","attributes":[{"name":"reference-element","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/ai-components/components/arcgis-assistant-layer-styling-agent/"}]},{"name":"arcgis-assistant-navigation-agent","description":"The Navigation Agent component enables the end user to navigate to different areas of a web map.\nIt allows you to type in a place name, address, or layer title to navigate to the desired location.\nCurrently, this is only scoped to navigation within a 2D map view.\n\nThis is an unrendered component that must be added as a child of the `arcgis-assistant` component in either HTML or JavaScript.\n\n```html\n<arcgis-assistant>\n <arcgis-assistant-navigation-agent></arcgis-assistant-navigation-agent>\n</arcgis-assistant>\n```\n\n```js\nconst assistant = document.querySelector(\"arcgis-assistant\");\nconst navigationAgent = document.createElement(\"arcgis-assistant-navigation-agent\");\nassistant.appendChild(navigationAgent);\n```\n--\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","attributes":[{"name":"reference-element","description":"A reference to the map element or its ID string used to resolve the MapView for this agent.\nIf not provided, the agent will attempt to find the closest parent `arcgis-map` element.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/ai-components/components/arcgis-assistant-navigation-agent/"},{"name":"Navigation Agent","url":"https://developers.arcgis.com/javascript/latest/storybook/ai-components/?path=/story/arcgis-assistant-navigation-agent--demo&singleStory=true"}]},{"name":"arcgis-assistant-chat","description":"### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","attributes":[{"name":"loading","values":[]},{"name":"loading-message","values":[]},{"name":"user","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/ai-components/components/arcgis-assistant-chat/"}]},{"name":"arcgis-assistant-chat-card","description":"### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","attributes":[{"name":"content","values":[]},{"name":"error","values":[]},{"name":"feedback-disabled","values":[]},{"name":"loading","values":[]},{"name":"loading-message","values":[]},{"name":"log","values":[]},{"name":"timestamp-disabled","values":[]},{"name":"type","values":[{"name":"prompt"},{"name":"response"}]},{"name":"user","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/ai-components/components/arcgis-assistant-chat-card/"}]},{"name":"arcgis-assistant-chat-card-content","description":"### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","attributes":[{"name":"content","values":[]},{"name":"loading","values":[]},{"name":"loading-message","values":[]},{"name":"type","values":[{"name":"chart"},{"name":"error"},{"name":"text"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/ai-components/components/arcgis-assistant-chat-card-content/"}]},{"name":"arcgis-assistant-chat-entry","description":"### Events\n- **arcgisCancel**\n- **arcgisSubmit**\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","attributes":[{"name":"awaiting-response","values":[]},{"name":"enter-key-submits","values":[]},{"name":"entry-placeholder","values":[]},{"name":"input-value","values":[]},{"name":"status","values":[{"name":"error"},{"name":"ready"},{"name":"working"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/ai-components/components/arcgis-assistant-chat-entry/"}]},{"name":"arcgis-assistant-interrupt","description":"### Events\n- **arcgisCancel**\n- **arcgisSubmit**\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","attributes":[{"name":"message","values":[]},{"name":"type","values":[{"name":"boolean-choice"},{"name":"multi-select"},{"name":"single-select"},{"name":"text-input"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/ai-components/components/arcgis-assistant-interrupt/"}]},{"name":"arcgis-assistant-shell","description":"### Events\n- **arcgisCancel**\n- **arcgisSubmit**\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","attributes":[{"name":"awaiting-response","values":[]},{"name":"description","values":[]},{"name":"entry-message","values":[]},{"name":"entry-message-closed","values":[]},{"name":"heading","values":[]},{"name":"input-value","values":[]},{"name":"loading","values":[]},{"name":"status","values":[{"name":"error"},{"name":"ready"},{"name":"working"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/ai-components/components/arcgis-assistant-shell/"}]}]}
@@ -1 +1 @@
1
- {"$schema":"https://raw.githubusercontent.com/JetBrains/web-types/master/schema/web-types.json","name":"@arcgis/ai-components","version":"5.0.0-next.151","description-markup":"markdown","contributions":{"html":{"elements":[{"name":"arcgis-assistant","description":"The ArcGIS Assistant component provides a chat-based natural language interface for interacting with\nmap data and services. This component relies on large language models to understand user prompts and\ngenerate both text and structured responses based on the user's intent and the context of the map.\n\nBy default, the `arcgis-assistant` component does not include any agents. You must register at least one\nagent for the assistant to function. You can register agents declaratively using any of the\navailable agent components, or you can register custom agents.\n\n## Register ArcGIS agents\n\nTo register ArcGIS agents declaratively, include one or more of the following agent components as children\nof the `arcgis-assistant` component. This can be done in HTML or programmatically using JavaScript.\n\n```html\n<arcgis-assistant>\n <arcgis-assistant-navigation-agent></arcgis-assistant-navigation-agent>\n <arcgis-assistant-data-exploration-agent></arcgis-assistant-data-exploration-agent>\n</arcgis-assistant>\n```\n\n```js\nconst assistant = document.querySelector(\"arcgis-assistant\");\nconst navigationAgent = document.createElement(\"arcgis-assistant-navigation-agent\");\nconst dataExplorationAgent = document.createElement(\"arcgis-assistant-data-exploration-agent\");\nassistant.appendChild(navigationAgent);\nassistant.appendChild(dataExplorationAgent);\n```\n\nTo learn more about this component, try out the [demo](#demo) below.\n--\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n\n### Slots\n- _default_ - This is the default slot\n- **header-actions-end** - Slot for adding actions to the end of the header.\n- **entry-message** - Slot for adding a welcome or entry message on load.\n- **entry-actions-start** - Slot for adding actions to the start of the entry area.\n- **footer-content** - Slot for adding content to the footer.","doc-url":"https://developers.arcgis.com/javascript/latest/references/ai-components/arcgis-assistant/","attributes":[{"name":"description","description":"The description text displayed below the heading in the assistant. This text provides additional\ncontext about the assistant's capabilities and how users can interact with it.","value":{"type":"string"}},{"name":"entry-message","description":"The message to display when the assistant is first loaded.","value":{"type":"string"}},{"name":"heading","description":"The heading text displayed at the top of the assistant. This name should be concise and\ndescriptive of the assistant's purpose.","value":{"type":"string"}},{"name":"reference-element","description":"The reference element to the map that provides context for the assistant and its agents. Currently,\nthis is only scoped to `arcgis-map` elements, but may be extended to support other elements in\nthe future.","value":{"type":["string","object"]}}],"slots":[{"name":"","description":"This is the default slot"},{"name":"header-actions-end","description":"Slot for adding actions to the end of the header."},{"name":"entry-message","description":"Slot for adding a welcome or entry message on load."},{"name":"entry-actions-start","description":"Slot for adding actions to the start of the entry area."},{"name":"footer-content","description":"Slot for adding content to the footer."}],"events":[],"js":{"properties":[{"name":"description","description":"The description text displayed below the heading in the assistant. This text provides additional\ncontext about the assistant's capabilities and how users can interact with it.","type":"string | undefined"},{"name":"entryMessage","description":"The message to display when the assistant is first loaded.","type":"string | undefined"},{"name":"heading","description":"The heading text displayed at the top of the assistant. This name should be concise and\ndescriptive of the assistant's purpose.","type":"string | undefined"},{"name":"portal","description":"The portal used for authentication and making requests to the LLM via proxy requests.","type":"Portal"},{"name":"referenceElement","description":"The reference element to the map that provides context for the assistant and its agents. Currently,\nthis is only scoped to `arcgis-map` elements, but may be extended to support other elements in\nthe future.","type":"ArcgisMap | string | null"},{"name":"suggestedPrompts","description":"Suggested prompts to display in the assistant on load. These are intended to help users get started\nwith common queries or actions.You should typically provide 2-3 suggested prompts that are\nrelevant to the context of the data being used and the capabilities of the registered agents.","type":"string[]"}],"events":[]}},{"name":"arcgis-assistant-agent","description":"The Assistant Agent component is a generic wrapper for adding custom AI agents into the ArcGIS Assistant component. To define\na custom agent, you must be familiar with [LangGraph](https://docs.langchain.com/oss/javascript/langgraph/overview). Custom agents must\ninclude a StateGraph that defines the agent's graph and subgraphs.\n\n> Building custom agents can only be done using modern JavaScript/TypeScript tooling and cannot be done directly in HTML using\nCDN imports. Therefore, you must use a package manager like npm or yarn to install the required dependencies. Please refer to the\nCreating Custom Agents guide for more instructions.\n\nThis is an unrendered component that must be added as a child of the `arcgis-assistant` component in either HTML or JavaScript.\n\n```html\n<arcgis-assistant></arcgis-assistant>\n```\n\n```js\nconst myCustomAgent = {\n id: \"my-custom-agent\",\n name: \"My Custom Agent\",\n description: \"An agent that does custom things. Use this agent when users want to do custom things.\",\n createGraph: {\n // StateGraph definition using LangGraph\n },\n workspace: {\n // AnnotationRoot definition using LangGraph\n // relevant variables and context required by the agent\n },\n};\n\nconst assistant = document.querySelector(\"arcgis-assistant\");\nconst assistantAgent = document.createElement(\"arcgis-assistant-agent\");\n\nassistantAgent.agent = myCustomAgent;\nassistant.appendChild(assistantAgent);\n```\n--\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","doc-url":"https://developers.arcgis.com/javascript/latest/references/ai-components/arcgis-assistant-agent/","attributes":[],"events":[],"js":{"properties":[{"name":"agent","description":"The agent registration object that defines the AI agent's behavior and capabilities.\nThis must include a StateGraph definition (defined using\n[LangGraph](https://docs.langchain.com/oss/javascript/langgraph/overview)).\n\nThis is an agent defined in the client and can be invoked by the assistant within the browser to perform specific tasks\nusing functions defined in the client.\n\nSee the Creating Custom Agents guide for more instructions.","type":"AgentRegistration"},{"name":"context","description":"If the agent requires context, it can be provided via this property and accessed in the\nagent's graph nodes.","type":"TContext | undefined"}],"events":[]}},{"name":"arcgis-assistant-data-exploration-agent","description":"The Data Exploration Agent component enables the end user to query features, statistics, and spatial proximity\nof layer within a provided web map. Currently, this is only scoped to querying feature layers within\na 2D web map.\n\nThis is an unrendered component that must be added as a child of the `arcgis-assistant` component in either HTML or JavaScript.\n\n```html\n<arcgis-assistant>\n <arcgis-assistant-data-exploration-agent></arcgis-assistant-data-exploration-agent>\n</arcgis-assistant>\n```\n\n```js\nconst assistant = document.querySelector(\"arcgis-assistant\");\nconst dataExplorationAgent = document.createElement(\"arcgis-assistant-data-exploration-agent\");\nassistant.appendChild(dataExplorationAgent);\n```\n--\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","doc-url":"https://developers.arcgis.com/javascript/latest/references/ai-components/arcgis-assistant-data-exploration-agent/","attributes":[{"name":"reference-element","description":"A reference to the map element or its ID string used to resolve the MapView for this agent.\nIf not provided, the agent will attempt to find the closest parent `arcgis-map` element.","value":{"type":["string","object"]}}],"events":[],"js":{"properties":[{"name":"referenceElement","description":"A reference to the map element or its ID string used to resolve the MapView for this agent.\nIf not provided, the agent will attempt to find the closest parent `arcgis-map` element.","type":"ArcgisMap | string | undefined"}],"events":[]}},{"name":"arcgis-assistant-layer-filter-agent","description":"### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","doc-url":"https://developers.arcgis.com/javascript/latest/references/ai-components/arcgis-assistant-layer-filter-agent/","attributes":[{"name":"reference-element","value":{"type":["string","object"]}}],"events":[],"js":{"properties":[{"name":"referenceElement","type":"ArcgisMap | string | undefined"}],"events":[]}},{"name":"arcgis-assistant-layer-query-agent","description":"### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","doc-url":"https://developers.arcgis.com/javascript/latest/references/ai-components/arcgis-assistant-layer-query-agent/","attributes":[{"name":"reference-element","value":{"type":["string","object"]}}],"events":[],"js":{"properties":[{"name":"referenceElement","type":"ArcgisMap | string | undefined"}],"events":[]}},{"name":"arcgis-assistant-layer-styling-agent","description":"### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","doc-url":"https://developers.arcgis.com/javascript/latest/references/ai-components/arcgis-assistant-layer-styling-agent/","attributes":[{"name":"reference-element","value":{"type":["string","object"]}}],"events":[],"js":{"properties":[{"name":"referenceElement","type":"ArcgisMap | string | undefined"}],"events":[]}},{"name":"arcgis-assistant-navigation-agent","description":"The Navigation Agent component enables the end user to navigate to different areas of a web map.\nIt allows you to type in a place name, address, or layer title to navigate to the desired location.\nCurrently, this is only scoped to navigation within a 2D map view.\n\nThis is an unrendered component that must be added as a child of the `arcgis-assistant` component in either HTML or JavaScript.\n\n```html\n<arcgis-assistant>\n <arcgis-assistant-navigation-agent></arcgis-assistant-navigation-agent>\n</arcgis-assistant>\n```\n\n```js\nconst assistant = document.querySelector(\"arcgis-assistant\");\nconst navigationAgent = document.createElement(\"arcgis-assistant-navigation-agent\");\nassistant.appendChild(navigationAgent);\n```\n--\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","doc-url":"https://developers.arcgis.com/javascript/latest/references/ai-components/arcgis-assistant-navigation-agent/","attributes":[{"name":"reference-element","description":"A reference to the map element or its ID string used to resolve the MapView for this agent.\nIf not provided, the agent will attempt to find the closest parent `arcgis-map` element.","value":{"type":["string","object"]}}],"events":[],"js":{"properties":[{"name":"referenceElement","description":"A reference to the map element or its ID string used to resolve the MapView for this agent.\nIf not provided, the agent will attempt to find the closest parent `arcgis-map` element.","type":"ArcgisMap | string | undefined"}],"events":[]}},{"name":"arcgis-assistant-chat","description":"### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","doc-url":"https://developers.arcgis.com/javascript/latest/references/ai-components/arcgis-assistant-chat/","attributes":[{"name":"loading","default":"false","value":{"type":"boolean"}},{"name":"loading-message","default":"\"\"","value":{"type":"string"}},{"name":"user","value":{"type":"string"}}],"events":[],"js":{"properties":[{"name":"loading","type":"boolean"},{"name":"loadingMessage","type":"string"},{"name":"messages","type":"Collection<{\n type: \"prompt\" | \"response\";\n content?: string;\n log?: string;\n error?: string;\n}>"},{"name":"user","type":"string | undefined"}],"events":[]}},{"name":"arcgis-assistant-chat-card","description":"### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","doc-url":"https://developers.arcgis.com/javascript/latest/references/ai-components/arcgis-assistant-chat-card/","attributes":[{"name":"content","value":{"type":"string"}},{"name":"error","value":{"type":"string"}},{"name":"feedback-disabled","default":"false","value":{"type":"boolean"}},{"name":"loading","default":"false","value":{"type":"boolean"}},{"name":"loading-message","value":{"type":"string"}},{"name":"log","value":{"type":"string"}},{"name":"timestamp-disabled","default":"false","value":{"type":"boolean"}},{"name":"type","default":"\"prompt\"","value":{"type":["\"prompt\"","\"response\""]}},{"name":"user","value":{"type":"string"}}],"events":[],"js":{"properties":[{"name":"content","type":"string | undefined"},{"name":"error","type":"string | undefined"},{"name":"feedbackDisabled","type":"boolean"},{"name":"loading","type":"boolean"},{"name":"loadingMessage","type":"string | undefined"},{"name":"log","type":"string | undefined"},{"name":"timestampDisabled","type":"boolean"},{"name":"type","type":"\"prompt\" | \"response\""},{"name":"user","type":"string | undefined"}],"events":[]}},{"name":"arcgis-assistant-chat-card-content","description":"### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","doc-url":"https://developers.arcgis.com/javascript/latest/references/ai-components/arcgis-assistant-chat-card-content/","attributes":[{"name":"content","value":{"type":"string"}},{"name":"loading","default":"false","value":{"type":"boolean"}},{"name":"loading-message","value":{"type":"string"}},{"name":"type","default":"\"text\"","value":{"type":["\"chart\"","\"error\"","\"text\""]}}],"events":[],"js":{"properties":[{"name":"content","type":"string | undefined"},{"name":"loading","type":"boolean"},{"name":"loadingMessage","type":"string | undefined"},{"name":"type","type":"\"chart\" | \"error\" | \"text\""}],"events":[]}},{"name":"arcgis-assistant-chat-entry","description":"### Events\n- **arcgisCancel**\n- **arcgisSubmit**\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","doc-url":"https://developers.arcgis.com/javascript/latest/references/ai-components/arcgis-assistant-chat-entry/","attributes":[{"name":"awaiting-response","default":"false","value":{"type":"boolean"}},{"name":"enter-key-submits","default":"true","value":{"type":"boolean"}},{"name":"entry-placeholder","value":{"type":"string"}},{"name":"input-value","default":"\"\"","value":{"type":"string"}},{"name":"status","value":{"type":["\"error\"","\"ready\"","\"working\""]}}],"events":[{"name":"arcgisCancel","type":"void"},{"name":"arcgisSubmit","type":"string"}],"js":{"properties":[{"name":"awaitingResponse","type":"boolean"},{"name":"enterKeySubmits","type":"boolean"},{"name":"entryPlaceholder","type":"string | undefined"},{"name":"inputValue","type":"string"},{"name":"status","type":"\"error\" | \"ready\" | \"working\" | undefined"}],"events":[{"name":"arcgisCancel","type":"void"},{"name":"arcgisSubmit","type":"string"}]}},{"name":"arcgis-assistant-interrupt","description":"### Events\n- **arcgisCancel**\n- **arcgisSubmit**\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","doc-url":"https://developers.arcgis.com/javascript/latest/references/ai-components/arcgis-assistant-interrupt/","attributes":[{"name":"message","value":{"type":"string"}},{"name":"type","value":{"type":["\"boolean-choice\"","\"multi-select\"","\"single-select\"","\"text-input\""]}}],"events":[{"name":"arcgisCancel","type":"void"},{"name":"arcgisSubmit","type":"string[] | string"}],"js":{"properties":[{"name":"message","type":"string | undefined"},{"name":"options","type":"string[] | undefined"},{"name":"type","type":"\"boolean-choice\" | \"multi-select\" | \"single-select\" | \"text-input\""}],"events":[{"name":"arcgisCancel","type":"void"},{"name":"arcgisSubmit","type":"string[] | string"}]}},{"name":"arcgis-assistant-shell","description":"### Events\n- **arcgisCancel**\n- **arcgisSubmit**\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","doc-url":"https://developers.arcgis.com/javascript/latest/references/ai-components/arcgis-assistant-shell/","attributes":[{"name":"awaiting-response","default":"false","value":{"type":"boolean"}},{"name":"description","default":"\"\"","value":{"type":"string"}},{"name":"entry-message","value":{"type":"string"}},{"name":"entry-message-closed","default":"false","value":{"type":"boolean"}},{"name":"heading","value":{"type":"string"}},{"name":"input-value","default":"\"\"","value":{"type":"string"}},{"name":"loading","default":"false","value":{"type":"boolean"}},{"name":"status","value":{"type":["\"error\"","\"ready\"","\"working\""]}}],"events":[{"name":"arcgisCancel","type":"void"},{"name":"arcgisSubmit","type":"string"}],"js":{"properties":[{"name":"awaitingResponse","type":"boolean"},{"name":"description","type":"string"},{"name":"entryMessage","type":"string | undefined"},{"name":"entryMessageClosed","type":"boolean"},{"name":"heading","type":"string | undefined"},{"name":"inputValue","type":"string"},{"name":"loading","type":"boolean"},{"name":"status","type":"\"error\" | \"ready\" | \"working\" | undefined"},{"name":"suggestedPrompts","type":"string[]"}],"events":[{"name":"arcgisCancel","type":"void"},{"name":"arcgisSubmit","type":"string"}]}}]},"css":{"properties":[],"pseudo-elements":[]}}}
1
+ {"$schema":"https://raw.githubusercontent.com/JetBrains/web-types/master/schema/web-types.json","name":"@arcgis/ai-components","version":"5.0.0-next.152","description-markup":"markdown","contributions":{"html":{"elements":[{"name":"arcgis-assistant","description":"The ArcGIS Assistant component provides a chat-based natural language interface for interacting with\nmap data and services. This component relies on large language models to understand user prompts and\ngenerate both text and structured responses based on the user's intent and the context of the map.\n\nBy default, the `arcgis-assistant` component does not include any agents. You must register at least one\nagent for the assistant to function. You can register agents declaratively using any of the\navailable agent components, or you can register custom agents.\n\n## Register ArcGIS agents\n\nTo register ArcGIS agents declaratively, include one or more of the following agent components as children\nof the `arcgis-assistant` component. This can be done in HTML or programmatically using JavaScript.\n\n```html\n<arcgis-assistant>\n <arcgis-assistant-navigation-agent></arcgis-assistant-navigation-agent>\n <arcgis-assistant-data-exploration-agent></arcgis-assistant-data-exploration-agent>\n</arcgis-assistant>\n```\n\n```js\nconst assistant = document.querySelector(\"arcgis-assistant\");\nconst navigationAgent = document.createElement(\"arcgis-assistant-navigation-agent\");\nconst dataExplorationAgent = document.createElement(\"arcgis-assistant-data-exploration-agent\");\nassistant.appendChild(navigationAgent);\nassistant.appendChild(dataExplorationAgent);\n```\n\nTo learn more about this component, try out the [demo](#demo) below.\n--\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n\n### Slots\n- _default_ - This is the default slot\n- **header-actions-end** - Slot for adding actions to the end of the header.\n- **entry-message** - Slot for adding a welcome or entry message on load.\n- **entry-actions-start** - Slot for adding actions to the start of the entry area.\n- **footer-content** - Slot for adding content to the footer.","doc-url":"https://developers.arcgis.com/javascript/latest/references/ai-components/components/arcgis-assistant/","attributes":[{"name":"description","description":"The description text displayed below the heading in the assistant. This text provides additional\ncontext about the assistant's capabilities and how users can interact with it.","value":{"type":"string"}},{"name":"entry-message","description":"The message to display when the assistant is first loaded.","value":{"type":"string"}},{"name":"heading","description":"The heading text displayed at the top of the assistant. This name should be concise and\ndescriptive of the assistant's purpose.","value":{"type":"string"}},{"name":"reference-element","description":"The reference element to the map that provides context for the assistant and its agents. Currently,\nthis is only scoped to `arcgis-map` elements, but may be extended to support other elements in\nthe future.","value":{"type":["string","object"]}}],"slots":[{"name":"","description":"This is the default slot"},{"name":"header-actions-end","description":"Slot for adding actions to the end of the header."},{"name":"entry-message","description":"Slot for adding a welcome or entry message on load."},{"name":"entry-actions-start","description":"Slot for adding actions to the start of the entry area."},{"name":"footer-content","description":"Slot for adding content to the footer."}],"events":[],"js":{"properties":[{"name":"description","description":"The description text displayed below the heading in the assistant. This text provides additional\ncontext about the assistant's capabilities and how users can interact with it.","type":"string | undefined"},{"name":"entryMessage","description":"The message to display when the assistant is first loaded.","type":"string | undefined"},{"name":"heading","description":"The heading text displayed at the top of the assistant. This name should be concise and\ndescriptive of the assistant's purpose.","type":"string | undefined"},{"name":"portal","description":"The portal used for authentication and making requests to the LLM via proxy requests.","type":"Portal"},{"name":"referenceElement","description":"The reference element to the map that provides context for the assistant and its agents. Currently,\nthis is only scoped to `arcgis-map` elements, but may be extended to support other elements in\nthe future.","type":"ArcgisMap | string | null"},{"name":"suggestedPrompts","description":"Suggested prompts to display in the assistant on load. These are intended to help users get started\nwith common queries or actions.You should typically provide 2-3 suggested prompts that are\nrelevant to the context of the data being used and the capabilities of the registered agents.","type":"string[]"}],"events":[]}},{"name":"arcgis-assistant-agent","description":"The Assistant Agent component is a generic wrapper for adding custom AI agents into the ArcGIS Assistant component. To define\na custom agent, you must be familiar with [LangGraph](https://docs.langchain.com/oss/javascript/langgraph/overview). Custom agents must\ninclude a StateGraph that defines the agent's graph and subgraphs.\n\n> Building custom agents can only be done using modern JavaScript/TypeScript tooling and cannot be done directly in HTML using\nCDN imports. Therefore, you must use a package manager like npm or yarn to install the required dependencies. Please refer to the\nCreating Custom Agents guide for more instructions.\n\nThis is an unrendered component that must be added as a child of the `arcgis-assistant` component in either HTML or JavaScript.\n\n```html\n<arcgis-assistant></arcgis-assistant>\n```\n\n```js\nconst myCustomAgent = {\n id: \"my-custom-agent\",\n name: \"My Custom Agent\",\n description: \"An agent that does custom things. Use this agent when users want to do custom things.\",\n createGraph: {\n // StateGraph definition using LangGraph\n },\n workspace: {\n // AnnotationRoot definition using LangGraph\n // relevant variables and context required by the agent\n },\n};\n\nconst assistant = document.querySelector(\"arcgis-assistant\");\nconst assistantAgent = document.createElement(\"arcgis-assistant-agent\");\n\nassistantAgent.agent = myCustomAgent;\nassistant.appendChild(assistantAgent);\n```\n--\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","doc-url":"https://developers.arcgis.com/javascript/latest/references/ai-components/components/arcgis-assistant-agent/","attributes":[],"events":[],"js":{"properties":[{"name":"agent","description":"The agent registration object that defines the AI agent's behavior and capabilities.\nThis must include a StateGraph definition (defined using\n[LangGraph](https://docs.langchain.com/oss/javascript/langgraph/overview)).\n\nThis is an agent defined in the client and can be invoked by the assistant within the browser to perform specific tasks\nusing functions defined in the client.\n\nSee the Creating Custom Agents guide for more instructions.","type":"AgentRegistration"},{"name":"context","description":"If the agent requires context, it can be provided via this property and accessed in the\nagent's graph nodes.","type":"TContext | undefined"}],"events":[]}},{"name":"arcgis-assistant-data-exploration-agent","description":"The Data Exploration Agent component enables the end user to query features, statistics, and spatial proximity\nof layer within a provided web map. Currently, this is only scoped to querying feature layers within\na 2D web map.\n\nThis is an unrendered component that must be added as a child of the `arcgis-assistant` component in either HTML or JavaScript.\n\n```html\n<arcgis-assistant>\n <arcgis-assistant-data-exploration-agent></arcgis-assistant-data-exploration-agent>\n</arcgis-assistant>\n```\n\n```js\nconst assistant = document.querySelector(\"arcgis-assistant\");\nconst dataExplorationAgent = document.createElement(\"arcgis-assistant-data-exploration-agent\");\nassistant.appendChild(dataExplorationAgent);\n```\n--\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","doc-url":"https://developers.arcgis.com/javascript/latest/references/ai-components/components/arcgis-assistant-data-exploration-agent/","attributes":[{"name":"reference-element","description":"A reference to the map element or its ID string used to resolve the MapView for this agent.\nIf not provided, the agent will attempt to find the closest parent `arcgis-map` element.","value":{"type":["string","object"]}}],"events":[],"js":{"properties":[{"name":"referenceElement","description":"A reference to the map element or its ID string used to resolve the MapView for this agent.\nIf not provided, the agent will attempt to find the closest parent `arcgis-map` element.","type":"ArcgisMap | string | undefined"}],"events":[]}},{"name":"arcgis-assistant-layer-filter-agent","description":"### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","doc-url":"https://developers.arcgis.com/javascript/latest/references/ai-components/components/arcgis-assistant-layer-filter-agent/","attributes":[{"name":"reference-element","value":{"type":["string","object"]}}],"events":[],"js":{"properties":[{"name":"referenceElement","type":"ArcgisMap | string | undefined"}],"events":[]}},{"name":"arcgis-assistant-layer-query-agent","description":"### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","doc-url":"https://developers.arcgis.com/javascript/latest/references/ai-components/components/arcgis-assistant-layer-query-agent/","attributes":[{"name":"reference-element","value":{"type":["string","object"]}}],"events":[],"js":{"properties":[{"name":"referenceElement","type":"ArcgisMap | string | undefined"}],"events":[]}},{"name":"arcgis-assistant-layer-styling-agent","description":"### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","doc-url":"https://developers.arcgis.com/javascript/latest/references/ai-components/components/arcgis-assistant-layer-styling-agent/","attributes":[{"name":"reference-element","value":{"type":["string","object"]}}],"events":[],"js":{"properties":[{"name":"referenceElement","type":"ArcgisMap | string | undefined"}],"events":[]}},{"name":"arcgis-assistant-navigation-agent","description":"The Navigation Agent component enables the end user to navigate to different areas of a web map.\nIt allows you to type in a place name, address, or layer title to navigate to the desired location.\nCurrently, this is only scoped to navigation within a 2D map view.\n\nThis is an unrendered component that must be added as a child of the `arcgis-assistant` component in either HTML or JavaScript.\n\n```html\n<arcgis-assistant>\n <arcgis-assistant-navigation-agent></arcgis-assistant-navigation-agent>\n</arcgis-assistant>\n```\n\n```js\nconst assistant = document.querySelector(\"arcgis-assistant\");\nconst navigationAgent = document.createElement(\"arcgis-assistant-navigation-agent\");\nassistant.appendChild(navigationAgent);\n```\n--\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","doc-url":"https://developers.arcgis.com/javascript/latest/references/ai-components/components/arcgis-assistant-navigation-agent/","attributes":[{"name":"reference-element","description":"A reference to the map element or its ID string used to resolve the MapView for this agent.\nIf not provided, the agent will attempt to find the closest parent `arcgis-map` element.","value":{"type":["string","object"]}}],"events":[],"js":{"properties":[{"name":"referenceElement","description":"A reference to the map element or its ID string used to resolve the MapView for this agent.\nIf not provided, the agent will attempt to find the closest parent `arcgis-map` element.","type":"ArcgisMap | string | undefined"}],"events":[]}},{"name":"arcgis-assistant-chat","description":"### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","doc-url":"https://developers.arcgis.com/javascript/latest/references/ai-components/components/arcgis-assistant-chat/","attributes":[{"name":"loading","default":"false","value":{"type":"boolean"}},{"name":"loading-message","default":"\"\"","value":{"type":"string"}},{"name":"user","value":{"type":"string"}}],"events":[],"js":{"properties":[{"name":"loading","type":"boolean"},{"name":"loadingMessage","type":"string"},{"name":"messages","type":"Collection<{\n type: \"prompt\" | \"response\";\n content?: string;\n log?: string;\n error?: string;\n}>"},{"name":"user","type":"string | undefined"}],"events":[]}},{"name":"arcgis-assistant-chat-card","description":"### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","doc-url":"https://developers.arcgis.com/javascript/latest/references/ai-components/components/arcgis-assistant-chat-card/","attributes":[{"name":"content","value":{"type":"string"}},{"name":"error","value":{"type":"string"}},{"name":"feedback-disabled","default":"false","value":{"type":"boolean"}},{"name":"loading","default":"false","value":{"type":"boolean"}},{"name":"loading-message","value":{"type":"string"}},{"name":"log","value":{"type":"string"}},{"name":"timestamp-disabled","default":"false","value":{"type":"boolean"}},{"name":"type","default":"\"prompt\"","value":{"type":["\"prompt\"","\"response\""]}},{"name":"user","value":{"type":"string"}}],"events":[],"js":{"properties":[{"name":"content","type":"string | undefined"},{"name":"error","type":"string | undefined"},{"name":"feedbackDisabled","type":"boolean"},{"name":"loading","type":"boolean"},{"name":"loadingMessage","type":"string | undefined"},{"name":"log","type":"string | undefined"},{"name":"timestampDisabled","type":"boolean"},{"name":"type","type":"\"prompt\" | \"response\""},{"name":"user","type":"string | undefined"}],"events":[]}},{"name":"arcgis-assistant-chat-card-content","description":"### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","doc-url":"https://developers.arcgis.com/javascript/latest/references/ai-components/components/arcgis-assistant-chat-card-content/","attributes":[{"name":"content","value":{"type":"string"}},{"name":"loading","default":"false","value":{"type":"boolean"}},{"name":"loading-message","value":{"type":"string"}},{"name":"type","default":"\"text\"","value":{"type":["\"chart\"","\"error\"","\"text\""]}}],"events":[],"js":{"properties":[{"name":"content","type":"string | undefined"},{"name":"loading","type":"boolean"},{"name":"loadingMessage","type":"string | undefined"},{"name":"type","type":"\"chart\" | \"error\" | \"text\""}],"events":[]}},{"name":"arcgis-assistant-chat-entry","description":"### Events\n- **arcgisCancel**\n- **arcgisSubmit**\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","doc-url":"https://developers.arcgis.com/javascript/latest/references/ai-components/components/arcgis-assistant-chat-entry/","attributes":[{"name":"awaiting-response","default":"false","value":{"type":"boolean"}},{"name":"enter-key-submits","default":"true","value":{"type":"boolean"}},{"name":"entry-placeholder","value":{"type":"string"}},{"name":"input-value","default":"\"\"","value":{"type":"string"}},{"name":"status","value":{"type":["\"error\"","\"ready\"","\"working\""]}}],"events":[{"name":"arcgisCancel","type":"void"},{"name":"arcgisSubmit","type":"string"}],"js":{"properties":[{"name":"awaitingResponse","type":"boolean"},{"name":"enterKeySubmits","type":"boolean"},{"name":"entryPlaceholder","type":"string | undefined"},{"name":"inputValue","type":"string"},{"name":"status","type":"\"error\" | \"ready\" | \"working\" | undefined"}],"events":[{"name":"arcgisCancel","type":"void"},{"name":"arcgisSubmit","type":"string"}]}},{"name":"arcgis-assistant-interrupt","description":"### Events\n- **arcgisCancel**\n- **arcgisSubmit**\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","doc-url":"https://developers.arcgis.com/javascript/latest/references/ai-components/components/arcgis-assistant-interrupt/","attributes":[{"name":"message","value":{"type":"string"}},{"name":"type","value":{"type":["\"boolean-choice\"","\"multi-select\"","\"single-select\"","\"text-input\""]}}],"events":[{"name":"arcgisCancel","type":"void"},{"name":"arcgisSubmit","type":"string[] | string"}],"js":{"properties":[{"name":"message","type":"string | undefined"},{"name":"options","type":"string[] | undefined"},{"name":"type","type":"\"boolean-choice\" | \"multi-select\" | \"single-select\" | \"text-input\""}],"events":[{"name":"arcgisCancel","type":"void"},{"name":"arcgisSubmit","type":"string[] | string"}]}},{"name":"arcgis-assistant-shell","description":"### Events\n- **arcgisCancel**\n- **arcgisSubmit**\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","doc-url":"https://developers.arcgis.com/javascript/latest/references/ai-components/components/arcgis-assistant-shell/","attributes":[{"name":"awaiting-response","default":"false","value":{"type":"boolean"}},{"name":"description","default":"\"\"","value":{"type":"string"}},{"name":"entry-message","value":{"type":"string"}},{"name":"entry-message-closed","default":"false","value":{"type":"boolean"}},{"name":"heading","value":{"type":"string"}},{"name":"input-value","default":"\"\"","value":{"type":"string"}},{"name":"loading","default":"false","value":{"type":"boolean"}},{"name":"status","value":{"type":["\"error\"","\"ready\"","\"working\""]}}],"events":[{"name":"arcgisCancel","type":"void"},{"name":"arcgisSubmit","type":"string"}],"js":{"properties":[{"name":"awaitingResponse","type":"boolean"},{"name":"description","type":"string"},{"name":"entryMessage","type":"string | undefined"},{"name":"entryMessageClosed","type":"boolean"},{"name":"heading","type":"string | undefined"},{"name":"inputValue","type":"string"},{"name":"loading","type":"boolean"},{"name":"status","type":"\"error\" | \"ready\" | \"working\" | undefined"},{"name":"suggestedPrompts","type":"string[]"}],"events":[{"name":"arcgisCancel","type":"void"},{"name":"arcgisSubmit","type":"string"}]}}]},"css":{"properties":[],"pseudo-elements":[]}}}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@arcgis/ai-components",
3
- "version": "5.0.0-next.151",
3
+ "version": "5.0.0-next.152",
4
4
  "type": "module",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.js",
@@ -23,11 +23,11 @@
23
23
  "dependencies": {
24
24
  "lit": "^3.3.0",
25
25
  "tslib": "^2.8.1",
26
- "@arcgis/ai-orchestrator": "5.0.0-next.151",
27
- "@arcgis/lumina": "5.0.0-next.151",
28
- "@arcgis/toolkit": "5.0.0-next.151",
29
- "@arcgis/map-components": "5.0.0-next.151",
30
- "@arcgis/ai-agents": "5.0.0-next.151"
26
+ "@arcgis/ai-agents": "5.0.0-next.152",
27
+ "@arcgis/ai-orchestrator": "5.0.0-next.152",
28
+ "@arcgis/lumina": "5.0.0-next.152",
29
+ "@arcgis/map-components": "5.0.0-next.152",
30
+ "@arcgis/toolkit": "5.0.0-next.152"
31
31
  },
32
32
  "peerDependencies": {
33
33
  "@arcgis/core": "^5.0.0-next",