@esri/hub-web-components 0.36.2 → 0.37.0

package/dist/docs/vscode.css-custom-data.json

@@ -1,6 +1 @@
-{
-  "$schema": "https://raw.githubusercontent.com/microsoft/vscode-css-languageservice/main/docs/customData.schema.json",
-  "version": 1.1,
-  "properties": [],
-  "pseudoElements": []
-}
+{"$schema":"https://raw.githubusercontent.com/microsoft/vscode-css-languageservice/main/docs/customData.schema.json","version":1.1,"properties":[],"pseudoElements":[]}

package/dist/docs/vscode.html-custom-data.json

@@ -1,257 +1 @@
-{
-  "$schema": "https://raw.githubusercontent.com/microsoft/vscode-html-languageservice/main/docs/customData.schema.json",
-  "version": 1.1,
-  "tags": [
-    {
-      "name": "arcgis-chat-shell",
-      "description": "### Events\n- **arcgisUpdateMapVisibility**\n- **hubTelemetry** - Event emitted when telemetry data is sent from the chat UI.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.",
-      "attributes": [
-        {
-          "name": "about-content",
-          "values": []
-        },
-        {
-          "name": "map-enabled",
-          "values": []
-        },
-        {
-          "name": "map-visible",
-          "values": []
-        }
-      ],
-      "references": []
-    },
-    {
-      "name": "arcgis-chat-ui",
-      "description": "### Events\n- **arcgisAddDataClick** - Event emitted when the user clicks to add data from a chat message.\n- **arcgisAppIdentityStartSignIn**\n- **arcgisLocationClick** - Event emitted when the user clicks a zoom to location button in a chat message.\n- **hubTelemetry** - Event emitted when telemetry data is sent from the chat UI.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `submitUserMessage(text: string, type: \"query\" | \"suggest\"): Promise<void>` - Submits the user's message to the chat.\nClears the input, adds the message to the chat history, and triggers the AI response.\nCurrently using the",
-      "attributes": [
-        {
-          "name": "bot-description",
-          "description": "The disclaimer text for the AI assistant",
-          "values": []
-        },
-        {
-          "name": "bot-title",
-          "description": "The title of the AI assistant",
-          "values": []
-        },
-        {
-          "name": "conversation-id",
-          "description": "The current conversation ID, or null if starting a new conversation.",
-          "values": []
-        },
-        {
-          "name": "domain",
-          "values": []
-        },
-        {
-          "name": "input-text",
-          "description": "The current text input value from the user.",
-          "values": []
-        }
-      ],
-      "references": []
-    },
-    {
-      "name": "arcgis-hub-ai-assistant",
-      "description": "### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.",
-      "attributes": [
-        {
-          "name": "bot-description",
-          "description": "Basic info about the bot to display in the \"About\" panel",
-          "values": []
-        },
-        {
-          "name": "bot-title",
-          "description": "The title of the AI assistant bot, displayed in the UI.",
-          "values": []
-        },
-        {
-          "name": "hub",
-          "description": "Hub domain to use for finding relevant datasets",
-          "values": []
-        },
-        {
-          "name": "item-id",
-          "description": "ArcGIS Item id for assistant configuration",
-          "values": []
-        },
-        {
-          "name": "item-modified-date",
-          "description": "The last modified timestamp of the assistant configuration item (site)",
-          "values": []
-        },
-        {
-          "name": "location",
-          "description": "Default geographic location to limit / focus results",
-          "values": []
-        },
-        {
-          "name": "map-enabled",
-          "description": "If the map is enabled (able to be togged on within the component).",
-          "values": []
-        },
-        {
-          "name": "map-show-table",
-          "description": "In the map, option to show the \"Table\" widget.",
-          "values": []
-        },
-        {
-          "name": "map-visible",
-          "description": "If the map is currently visible. Only applicable if `mapEnabled` is true.",
-          "values": []
-        }
-      ],
-      "references": []
-    },
-    {
-      "name": "arcgis-hub-entity-view-layout",
-      "description": "Component that renders a Hub entity view\nusing the layout system.\n\nIf an entity does not have a layout defined, we\nbuild a type-specific default layout from the entity's\nmetadata. The layout does not get persisted to the\nunderlying item until the user makes changes and\npublishes them.\n--\n\n### Events\n- **arcgisHubEntityViewPublished** - Event emitted when the layout is published.\n- **hubTelemetry** - Event emitted for telemetry\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.",
-      "attributes": [
-        {
-          "name": "is-edit-mode",
-          "description": "Whether the layout is in edit mode",
-          "values": []
-        }
-      ],
-      "references": []
-    },
-    {
-      "name": "arcgis-hub-entity-associations-card",
-      "description": "### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.",
-      "attributes": [
-        {
-          "name": "association-type",
-          "description": "entity type to query for",
-          "values": [
-            {
-              "name": "channel"
-            },
-            {
-              "name": "content"
-            },
-            {
-              "name": "discussion"
-            },
-            {
-              "name": "event"
-            },
-            {
-              "name": "group"
-            },
-            {
-              "name": "initiative"
-            },
-            {
-              "name": "initiativeTemplate"
-            },
-            {
-              "name": "org"
-            },
-            {
-              "name": "organization"
-            },
-            {
-              "name": "page"
-            },
-            {
-              "name": "project"
-            },
-            {
-              "name": "site"
-            },
-            {
-              "name": "survey"
-            },
-            {
-              "name": "template"
-            },
-            {
-              "name": "user"
-            }
-          ]
-        }
-      ],
-      "references": []
-    },
-    {
-      "name": "arcgis-hub-entity-metrics-card",
-      "description": "### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.",
-      "attributes": [],
-      "references": []
-    },
-    {
-      "name": "arcgis-hub-entity-status-card",
-      "description": "A card that can be added to an ILayout or leveraged\nindependently to render an entity's status.\n\nNOTE: this card is a temporary implementation, and\nwill likely be removed once we decide how to handle\nentity statuses in the context of the layout system\ne.g. via a text card with variables, for example\n--\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.",
-      "attributes": [],
-      "references": []
-    },
-    {
-      "name": "arcgis-nav-card",
-      "description": "The nav card is intended to render various\ntypes of in-place navigation in an ILayout (e.g.\ntabs, accordions, etc.).\n\nTODO: hook up other nav types (e.g. accordion)\nTODO: hook up query params (e.g. navigating to\na different tab should update the URL, thereby\nenabling deep linking).\n--\n\n### Events\n- **arcgisLayoutActivateNode**\n- **arcgisLayoutNodeFocus**\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.",
-      "attributes": [
-        {
-          "name": "debug",
-          "description": "Enables debug mode",
-          "values": []
-        },
-        {
-          "name": "is-edit-mode",
-          "description": "Whether the parent layout is in edit mode",
-          "values": []
-        }
-      ],
-      "references": []
-    },
-    {
-      "name": "arcgis-text-card",
-      "description": "A text card that can be added to an ILayout or leveraged\nindependently. The text content is sanitized before rendering\nto prevent XSS attacks.\n--\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.",
-      "attributes": [
-        {
-          "name": "html",
-          "description": "The HTML content to display - this will be\nsanitized before rendering.",
-          "values": []
-        }
-      ],
-      "references": []
-    },
-    {
-      "name": "arcgis-layout",
-      "description": "Web component for rendering an ILayout. Orchestrates\nthe rendering of sections, rows, columns, and cards\nas defined by the layout JSON.\n--\n\n### Events\n- **arcgisHubLayoutRendered** - Event emitted when the layout has finished\nrendering.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `getCardEl(nodeId: string): Promise<HTMLConfigurableLayoutNodeElement | undefined>` - Public method that returns the DOM element for a\nlayout node by id. Used for highlighting or\nscrolling to a node in the layout.",
-      "attributes": [
-        {
-          "name": "debug",
-          "description": "Enables debug mode.",
-          "values": []
-        },
-        {
-          "name": "is-edit-mode",
-          "description": "Whether the layout is in edit mode.",
-          "values": []
-        }
-      ],
-      "references": []
-    },
-    {
-      "name": "arcgis-layout-container",
-      "description": "### Events\n- **arcgisHubLayoutChanged** - Event emitted when the layout is edited\n- **arcgisHubLayoutEditorExit** - Event emitted when the layout editor is exited\n- **arcgisHubLayoutPublished** - Event emitted when the layout is published\n- **arcgisHubLayoutReset** - Event emitted when the layout is reset\n- **hubTelemetry** - Event emitted for telemetry\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.",
-      "attributes": [
-        {
-          "name": "debug",
-          "values": []
-        },
-        {
-          "name": "is-edit-mode",
-          "description": "Whether the layout is in edit mode",
-          "values": []
-        },
-        {
-          "name": "is-publishing",
-          "description": "Whether the layout is currently being published.\nWe use this to disable and show a loading state\non the \"Publish\" button in the edit toolbar.",
-          "values": []
-        }
-      ],
-      "references": []
-    }
-  ]
-}
+{"$schema":"https://raw.githubusercontent.com/microsoft/vscode-html-languageservice/main/docs/customData.schema.json","version":1.1,"tags":[{"name":"arcgis-chat-shell","description":"### Events\n- **arcgisUpdateMapVisibility**\n- **hubTelemetry** - Event emitted when telemetry data is sent from the chat UI.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","attributes":[{"name":"about-content","values":[]},{"name":"map-enabled","values":[]},{"name":"map-visible","values":[]}],"references":[]},{"name":"arcgis-chat-ui","description":"### Events\n- **arcgisAddDataClick** - Event emitted when the user clicks to add data from a chat message.\n- **arcgisAppIdentityStartSignIn**\n- **arcgisLocationClick** - Event emitted when the user clicks a zoom to location button in a chat message.\n- **hubTelemetry** - Event emitted when telemetry data is sent from the chat UI.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `submitUserMessage(text: string, type: \"query\" | \"suggest\"): Promise<void>` - Submits the user's message to the chat.\nClears the input, adds the message to the chat history, and triggers the AI response.\nCurrently using the @method decorator to expose this method to the DOM,\nallowing it to be called from `embed-modal.html`. Once this application has been migrated,\nI assume there will be no need for the html component and the @method decorator can be removed.","attributes":[{"name":"bot-description","description":"The disclaimer text for the AI assistant","values":[]},{"name":"bot-title","description":"The title of the AI assistant","values":[]},{"name":"conversation-id","description":"The current conversation ID, or null if starting a new conversation.","values":[]},{"name":"domain","values":[]},{"name":"input-text","description":"The current text input value from the user.","values":[]}],"references":[]},{"name":"arcgis-hub-ai-assistant","description":"### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","attributes":[{"name":"bot-description","description":"Basic info about the bot to display in the \"About\" panel","values":[]},{"name":"bot-title","description":"The title of the AI assistant bot, displayed in the UI.","values":[]},{"name":"hub","description":"Hub domain to use for finding relevant datasets","values":[]},{"name":"item-id","description":"ArcGIS Item id for assistant configuration","values":[]},{"name":"item-modified-date","description":"The last modified timestamp of the assistant configuration item (site)","values":[]},{"name":"location","description":"Default geographic location to limit / focus results","values":[]},{"name":"map-enabled","description":"If the map is enabled (able to be togged on within the component).","values":[]},{"name":"map-show-table","description":"In the map, option to show the \"Table\" widget.","values":[]},{"name":"map-visible","description":"If the map is currently visible. Only applicable if `mapEnabled` is true.","values":[]}],"references":[]},{"name":"arcgis-hub-entity-view-layout","description":"Component that renders a Hub entity view\nusing the layout system.\n\nIf an entity does not have a layout defined, we\nbuild a type-specific default layout from the entity's\nmetadata. The layout does not get persisted to the\nunderlying item until the user makes changes and\npublishes them.\n--\n\n### Events\n- **arcgisHubEntityViewPublished** - Event emitted when the layout is published.\n- **hubTelemetry** - Event emitted for telemetry\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","attributes":[{"name":"is-edit-mode","description":"Whether the layout is in edit mode","values":[]}],"references":[]},{"name":"arcgis-hub-entity-associations-card","description":"### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","attributes":[{"name":"association-type","description":"entity type to query for","values":[{"name":"template"},{"name":"event"},{"name":"group"},{"name":"initiative"},{"name":"initiativeTemplate"},{"name":"organization"},{"name":"survey"},{"name":"user"},{"name":"channel"},{"name":"content"},{"name":"org"},{"name":"page"},{"name":"project"},{"name":"site"},{"name":"discussion"}]}],"references":[]},{"name":"arcgis-hub-entity-metrics-card","description":"### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","attributes":[],"references":[]},{"name":"arcgis-hub-entity-status-card","description":"A card that can be added to an ILayout or leveraged\nindependently to render an entity's status.\n\nNOTE: this card is a temporary implementation, and\nwill likely be removed once we decide how to handle\nentity statuses in the context of the layout system\ne.g. via a text card with variables, for example\n--\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","attributes":[],"references":[]},{"name":"arcgis-nav-card","description":"The nav card is intended to render various\ntypes of in-place navigation in an ILayout (e.g.\ntabs, accordions, etc.).\n\nTODO: hook up other nav types (e.g. accordion)\nTODO: hook up query params (e.g. navigating to\na different tab should update the URL, thereby\nenabling deep linking).\n--\n\n### Events\n- **arcgisLayoutActivateNode**\n- **arcgisLayoutNodeFocus**\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","attributes":[{"name":"debug","description":"Enables debug mode","values":[]},{"name":"is-edit-mode","description":"Whether the parent layout is in edit mode","values":[]}],"references":[]},{"name":"arcgis-text-card","description":"A text card that can be added to an ILayout or leveraged\nindependently. The text content is sanitized before rendering\nto prevent XSS attacks.\n--\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","attributes":[{"name":"html","description":"The HTML content to display - this will be\nsanitized before rendering.","values":[]}],"references":[]},{"name":"arcgis-layout","description":"Web component for rendering an ILayout. Orchestrates\nthe rendering of sections, rows, columns, and cards\nas defined by the layout JSON.\n--\n\n### Events\n- **arcgisHubLayoutRendered** - Event emitted when the layout has finished\nrendering.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `getCardEl(nodeId: string): Promise<HTMLConfigurableLayoutNodeElement | undefined>` - Public method that returns the DOM element for a\nlayout node by id. Used for highlighting or\nscrolling to a node in the layout.","attributes":[{"name":"debug","description":"Enables debug mode.","values":[]},{"name":"is-edit-mode","description":"Whether the layout is in edit mode.","values":[]}],"references":[]},{"name":"arcgis-layout-container","description":"### Events\n- **arcgisHubLayoutChanged** - Event emitted when the layout is edited\n- **arcgisHubLayoutEditorExit** - Event emitted when the layout editor is exited\n- **arcgisHubLayoutPublished** - Event emitted when the layout is published\n- **arcgisHubLayoutReset** - Event emitted when the layout is reset\n- **hubTelemetry** - Event emitted for telemetry\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","attributes":[{"name":"debug","values":[]},{"name":"is-edit-mode","description":"Whether the layout is in edit mode","values":[]},{"name":"is-publishing","description":"Whether the layout is currently being published.\nWe use this to disable and show a loading state\non the \"Publish\" button in the edit toolbar.","values":[]}],"references":[]}]}