@esri/hub-web-components 0.0.9 → 0.2.0

package/dist/docs/api.json

@@ -1,8 +1,8 @@
 {
-  "timestamp": "2025-08-30T17:26:58",
+  "timestamp": "2025-09-26T22:05:30",
   "compiler": {
     "name": "@arcgis/lumina-compiler",
-    "version": "4.33.0-next.121",
+    "version": "4.33.19",
     "typescriptVersion": "5.8.3"
   },
   "schemaVersion": "1.0.0",
@@ -85,7 +85,7 @@
               "docsTags": [
                 {
                   "name": "example",
-                  "text": "const chatShell = document.createElement(\"arcgis-chat-shell\");\ndocument.body.append(chatShell);\nchatShell.componentOnReady().then(() => {\n  console.log(\"arcgis-chat-shell is ready to go!\");\n});"
+                  "text": "```js\nconst chatShell = document.querySelector(\"arcgis-chat-shell\");\ndocument.body.append(chatShell);\nawait chatShell.componentOnReady();\nconsole.log(\"arcgis-chat-shell is ready to go!\");\n```"
                 }
               ]
             },
@@ -215,6 +215,19 @@
                   }
                 ]
               }
+            },
+            {
+              "name": "hubTelemetry",
+              "description": "Event emitted when telemetry data is sent from the chat UI.",
+              "type": {
+                "text": "{\n    [x: string]: unknown;\n}"
+              },
+              "docsTags": [
+                {
+                  "name": "event",
+                  "text": "hubTelemetry"
+                }
+              ]
             }
           ]
         }
@@ -246,6 +259,23 @@
           "pascalCaseName": "ArcgisChatUi",
           "importPath": "components/arcgis-chat-ui",
           "members": [
+            {
+              "kind": "field",
+              "name": "authentication",
+              "description": "The authentication manager for ArcGIS API requests.",
+              "type": {
+                "text": "ArcGISIdentityManager",
+                "references": [
+                  {
+                    "name": "ArcGISIdentityManager",
+                    "package": "@esri/arcgis-rest-request",
+                    "module": "dist/esm/ArcGISIdentityManager.d.ts",
+                    "start": 0,
+                    "end": 21
+                  }
+                ]
+              }
+            },
             {
               "kind": "field",
               "name": "botDescription",
@@ -303,7 +333,7 @@
               "docsTags": [
                 {
                   "name": "example",
-                  "text": "const arcgisChatUI = document.createElement(\"arcgis-chat-ui\");\ndocument.body.append(arcgisChatUI);\narcgisChatUI.componentOnReady().then(() => {\n  console.log(\"arcgis-chat-ui is ready to go!\");\n});"
+                  "text": "```js\nconst arcgisChatUI = document.querySelector(\"arcgis-chat-ui\");\ndocument.body.append(arcgisChatUI);\nawait arcgisChatUI.componentOnReady();\nconsole.log(\"arcgis-chat-ui is ready to go!\");\n```"
                 }
               ]
             },
@@ -425,6 +455,20 @@
               "default": "\"\"",
               "attribute": "input-text"
             },
+            {
+              "kind": "field",
+              "name": "portalUrl",
+              "type": {
+                "text": "string",
+                "values": [
+                  {
+                    "type": "string"
+                  }
+                ]
+              },
+              "default": "\"https://www.arcgis.com\"",
+              "attribute": "portal-url"
+            },
             {
               "kind": "method",
               "name": "submitUserMessage",
@@ -440,6 +484,22 @@
                       }
                     ]
                   }
+                },
+                {
+                  "name": "type",
+                  "type": {
+                    "text": "\"query\" | \"suggest\"",
+                    "values": [
+                      {
+                        "value": "query",
+                        "type": "string"
+                      },
+                      {
+                        "value": "suggest",
+                        "type": "string"
+                      }
+                    ]
+                  }
                 }
               ],
               "return": {
@@ -461,7 +521,7 @@
                   "text": "text The user's input message."
                 }
               ],
-              "signature": "(text: string): void"
+              "signature": "(text: string, type: \"query\" | \"suggest\"): void"
             }
           ],
           "attributes": [
@@ -519,6 +579,19 @@
               },
               "default": "\"\"",
               "fieldName": "inputText"
+            },
+            {
+              "name": "portal-url",
+              "type": {
+                "text": "string",
+                "values": [
+                  {
+                    "type": "string"
+                  }
+                ]
+              },
+              "default": "\"https://www.arcgis.com\"",
+              "fieldName": "portalUrl"
             }
           ],
           "events": [
@@ -543,6 +616,19 @@
                   }
                 ]
               }
+            },
+            {
+              "name": "hubTelemetry",
+              "description": "Event emitted when telemetry data is sent from the chat UI.",
+              "type": {
+                "text": "{\n    [x: string]: unknown;\n}"
+              },
+              "docsTags": [
+                {
+                  "name": "event",
+                  "text": "hubTelemetry"
+                }
+              ]
             }
           ]
         }
@@ -663,7 +749,7 @@
               "docsTags": [
                 {
                   "name": "example",
-                  "text": "const arcGISHubAIAssistant = document.createElement(\"arcgis-hub-ai-assistant\");\ndocument.body.append(arcGISHubAIAssistant);\narcGISHubAIAssistant.componentOnReady().then(() => {\n  console.log(\"arcgis-hub-ai-assistant is ready to go!\");\n});"
+                  "text": "```js\nconst arcGISHubAIAssistant = document.querySelector(\"arcgis-hub-ai-assistant\");\ndocument.body.append(arcGISHubAIAssistant);\nawait arcGISHubAIAssistant.componentOnReady();\nconsole.log(\"arcgis-hub-ai-assistant is ready to go!\");\n```"
                 }
               ]
             },
@@ -1087,24 +1173,583 @@
               "default": "\"https://www.arcgis.com\"",
               "fieldName": "portalUrl"
             }
-          ],
-          "events": [
+          ]
+        }
+      ],
+      "exports": [
+        {
+          "kind": "custom-element-definition",
+          "name": "arcgis-hub-ai-assistant",
+          "declaration": {
+            "name": "ArcGISHubAIAssistant",
+            "module": "src/components/hub-ai-assistant/hub-ai-assistant.tsx"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/components/layouts/layout/layout.tsx",
+      "declarations": [
+        {
+          "kind": "class",
+          "customElement": true,
+          "name": "ArcgisLayout",
+          "tagName": "arcgis-layout",
+          "description": "A web component for rendering an ILayout",
+          "superclass": {
+            "name": "LitElement",
+            "package": "@arcgis/lumina"
+          },
+          "pascalCaseName": "ArcgisLayout",
+          "importPath": "components/arcgis-layout",
+          "members": [
+            {
+              "kind": "method",
+              "name": "componentOnReady",
+              "return": {
+                "type": {
+                  "text": "Promise<void>",
+                  "references": [
+                    {
+                      "module": "lib/lib.es5.d.ts",
+                      "name": "Promise",
+                      "package": "typescript",
+                      "start": 0,
+                      "end": 7
+                    }
+                  ]
+                }
+              },
+              "description": "Create a promise that resolves once component is fully loaded.",
+              "signature": "(): Promise<void>",
+              "async": true,
+              "inheritedFrom": {
+                "name": "LitElement",
+                "package": "@arcgis/lumina"
+              },
+              "docsTags": [
+                {
+                  "name": "example",
+                  "text": "```js\nconst arcgisLayout = document.querySelector(\"arcgis-layout\");\ndocument.body.append(arcgisLayout);\nawait arcgisLayout.componentOnReady();\nconsole.log(\"arcgis-layout is ready to go!\");\n```"
+                }
+              ]
+            },
+            {
+              "kind": "field",
+              "name": "currentNode",
+              "description": "The currently focused/hovered node. This is\ntracked in order to show the node's configuration\ncontrols and \"active\" state in the UI.",
+              "type": {
+                "text": "ILayoutNode",
+                "references": [
+                  {
+                    "name": "ILayoutNode",
+                    "module": "dist/components/layouts/types.d.ts",
+                    "start": 0,
+                    "end": 11
+                  }
+                ]
+              }
+            },
+            {
+              "kind": "field",
+              "name": "debug",
+              "description": "Enables debug mode",
+              "type": {
+                "text": "boolean",
+                "values": [
+                  {
+                    "type": "boolean"
+                  }
+                ]
+              },
+              "default": "false",
+              "attribute": "debug",
+              "reflects": true
+            },
+            {
+              "kind": "field",
+              "name": "isEditMode",
+              "description": "Whether the layout is in edit mode",
+              "type": {
+                "text": "boolean",
+                "values": [
+                  {
+                    "type": "boolean"
+                  }
+                ]
+              },
+              "default": "false",
+              "attribute": "is-edit-mode",
+              "reflects": true
+            },
+            {
+              "kind": "field",
+              "name": "layout",
+              "description": "The layout to render",
+              "type": {
+                "text": "ILayout",
+                "references": [
+                  {
+                    "name": "ILayout",
+                    "module": "dist/components/layouts/types.d.ts",
+                    "start": 0,
+                    "end": 7
+                  }
+                ]
+              }
+            },
             {
-              "name": "arcgisAddLayer",
+              "kind": "field",
+              "name": "options",
+              "description": "Options for processing the layout",
               "type": {
-                "text": "undefined"
+                "text": "IProcessLayoutOptions",
+                "references": [
+                  {
+                    "name": "IProcessLayoutOptions",
+                    "module": "dist/components/layouts/types.d.ts",
+                    "start": 0,
+                    "end": 21
+                  }
+                ]
               }
             }
+          ],
+          "attributes": [
+            {
+              "name": "debug",
+              "description": "Enables debug mode",
+              "type": {
+                "text": "boolean",
+                "values": [
+                  {
+                    "type": "boolean"
+                  }
+                ]
+              },
+              "default": "false",
+              "fieldName": "debug"
+            },
+            {
+              "name": "is-edit-mode",
+              "description": "Whether the layout is in edit mode",
+              "type": {
+                "text": "boolean",
+                "values": [
+                  {
+                    "type": "boolean"
+                  }
+                ]
+              },
+              "default": "false",
+              "fieldName": "isEditMode"
+            }
           ]
         }
       ],
       "exports": [
         {
           "kind": "custom-element-definition",
-          "name": "arcgis-hub-ai-assistant",
+          "name": "arcgis-layout",
           "declaration": {
-            "name": "ArcGISHubAIAssistant",
-            "module": "src/components/hub-ai-assistant/hub-ai-assistant.tsx"
+            "name": "ArcgisLayout",
+            "module": "src/components/layouts/layout/layout.tsx"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/components/layouts/layout-container/layout-container.tsx",
+      "declarations": [
+        {
+          "kind": "class",
+          "customElement": true,
+          "name": "ArcgisLayoutContainer",
+          "tagName": "arcgis-layout-container",
+          "superclass": {
+            "name": "LitElement",
+            "package": "@arcgis/lumina"
+          },
+          "encapsulation": "none",
+          "pascalCaseName": "ArcgisLayoutContainer",
+          "importPath": "components/arcgis-layout-container",
+          "members": [
+            {
+              "kind": "method",
+              "name": "componentOnReady",
+              "return": {
+                "type": {
+                  "text": "Promise<void>",
+                  "references": [
+                    {
+                      "module": "lib/lib.es5.d.ts",
+                      "name": "Promise",
+                      "package": "typescript",
+                      "start": 0,
+                      "end": 7
+                    }
+                  ]
+                }
+              },
+              "description": "Create a promise that resolves once component is fully loaded.",
+              "signature": "(): Promise<void>",
+              "async": true,
+              "inheritedFrom": {
+                "name": "LitElement",
+                "package": "@arcgis/lumina"
+              },
+              "docsTags": [
+                {
+                  "name": "example",
+                  "text": "```js\nconst arcgisLayoutContainer = document.querySelector(\"arcgis-layout-container\");\ndocument.body.append(arcgisLayoutContainer);\nawait arcgisLayoutContainer.componentOnReady();\nconsole.log(\"arcgis-layout-container is ready to go!\");\n```"
+                }
+              ]
+            },
+            {
+              "kind": "field",
+              "name": "debug",
+              "type": {
+                "text": "boolean",
+                "values": [
+                  {
+                    "type": "boolean"
+                  }
+                ]
+              },
+              "default": "false",
+              "attribute": "debug",
+              "reflects": true
+            },
+            {
+              "kind": "field",
+              "name": "isEditMode",
+              "description": "Whether the layout is in edit mode",
+              "type": {
+                "text": "boolean",
+                "values": [
+                  {
+                    "type": "boolean"
+                  }
+                ]
+              },
+              "default": "false",
+              "attribute": "is-edit-mode",
+              "reflects": true
+            },
+            {
+              "kind": "field",
+              "name": "layout",
+              "description": "The layout to render",
+              "type": {
+                "text": "ILayout",
+                "references": [
+                  {
+                    "name": "ILayout",
+                    "module": "dist/components/layouts/types.d.ts",
+                    "start": 0,
+                    "end": 7
+                  }
+                ]
+              }
+            },
+            {
+              "kind": "field",
+              "name": "options",
+              "description": "Options for processing the layout",
+              "type": {
+                "text": "IProcessLayoutOptions",
+                "references": [
+                  {
+                    "name": "IProcessLayoutOptions",
+                    "module": "dist/components/layouts/types.d.ts",
+                    "start": 0,
+                    "end": 21
+                  }
+                ]
+              }
+            }
+          ],
+          "attributes": [
+            {
+              "name": "debug",
+              "type": {
+                "text": "boolean",
+                "values": [
+                  {
+                    "type": "boolean"
+                  }
+                ]
+              },
+              "default": "false",
+              "fieldName": "debug"
+            },
+            {
+              "name": "is-edit-mode",
+              "description": "Whether the layout is in edit mode",
+              "type": {
+                "text": "boolean",
+                "values": [
+                  {
+                    "type": "boolean"
+                  }
+                ]
+              },
+              "default": "false",
+              "fieldName": "isEditMode"
+            }
+          ]
+        }
+      ],
+      "exports": [
+        {
+          "kind": "custom-element-definition",
+          "name": "arcgis-layout-container",
+          "declaration": {
+            "name": "ArcgisLayoutContainer",
+            "module": "src/components/layouts/layout-container/layout-container.tsx"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/components/nav-card/nav-card.tsx",
+      "declarations": [
+        {
+          "kind": "class",
+          "customElement": true,
+          "name": "ArcgisNavCard",
+          "tagName": "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).",
+          "superclass": {
+            "name": "LitElement",
+            "package": "@arcgis/lumina"
+          },
+          "encapsulation": "none",
+          "pascalCaseName": "ArcgisNavCard",
+          "importPath": "components/arcgis-nav-card",
+          "members": [
+            {
+              "kind": "method",
+              "name": "componentOnReady",
+              "return": {
+                "type": {
+                  "text": "Promise<void>",
+                  "references": [
+                    {
+                      "module": "lib/lib.es5.d.ts",
+                      "name": "Promise",
+                      "package": "typescript",
+                      "start": 0,
+                      "end": 7
+                    }
+                  ]
+                }
+              },
+              "description": "Create a promise that resolves once component is fully loaded.",
+              "signature": "(): Promise<void>",
+              "async": true,
+              "inheritedFrom": {
+                "name": "LitElement",
+                "package": "@arcgis/lumina"
+              },
+              "docsTags": [
+                {
+                  "name": "example",
+                  "text": "```js\nconst arcgisNavCard = document.querySelector(\"arcgis-nav-card\");\ndocument.body.append(arcgisNavCard);\nawait arcgisNavCard.componentOnReady();\nconsole.log(\"arcgis-nav-card is ready to go!\");\n```"
+                }
+              ]
+            },
+            {
+              "kind": "field",
+              "name": "sections",
+              "description": "The sections to render within the nav card",
+              "type": {
+                "text": "Array<ISection>",
+                "references": [
+                  {
+                    "name": "Array",
+                    "package": "typescript",
+                    "module": "lib/lib.es5.d.ts",
+                    "start": 0,
+                    "end": 5
+                  },
+                  {
+                    "name": "ISection",
+                    "module": "dist/components/layouts/types.d.ts",
+                    "start": 6,
+                    "end": 14
+                  }
+                ]
+              }
+            },
+            {
+              "kind": "field",
+              "name": "translations",
+              "description": "Customer provided translations to override the\ndefault strings.",
+              "type": {
+                "text": "ITranslationMap",
+                "references": [
+                  {
+                    "name": "ITranslationMap",
+                    "module": "dist/components/layouts/types.d.ts",
+                    "start": 0,
+                    "end": 15
+                  }
+                ]
+              }
+            }
+          ]
+        }
+      ],
+      "exports": [
+        {
+          "kind": "custom-element-definition",
+          "name": "arcgis-nav-card",
+          "declaration": {
+            "name": "ArcgisNavCard",
+            "module": "src/components/nav-card/nav-card.tsx"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/components/text-card/text-card.tsx",
+      "declarations": [
+        {
+          "kind": "class",
+          "customElement": true,
+          "name": "ArcgisTextCard",
+          "tagName": "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.",
+          "superclass": {
+            "name": "LitElement",
+            "package": "@arcgis/lumina"
+          },
+          "pascalCaseName": "ArcgisTextCard",
+          "importPath": "components/arcgis-text-card",
+          "members": [
+            {
+              "kind": "field",
+              "name": "canEdit",
+              "description": "Whether the text card can be edited or not.\nThis readonly property is consumed by the\narcgis-layout-node-controls to determine\nwhich layout controls to enable/disable.\nTODO: make permissions-based?",
+              "type": {
+                "text": "boolean",
+                "values": [
+                  {
+                    "type": "boolean"
+                  }
+                ]
+              },
+              "default": "false",
+              "readonly": true
+            },
+            {
+              "kind": "field",
+              "name": "canMove",
+              "description": "Whether the text card can be moved or not.\nThis readonly property is consumed by the\narcgis-layout-node-controls to determine\nwhich layout controls to enable/disable.\nTODO: make permissions-based?",
+              "type": {
+                "text": "boolean",
+                "values": [
+                  {
+                    "type": "boolean"
+                  }
+                ]
+              },
+              "default": "false",
+              "readonly": true
+            },
+            {
+              "kind": "method",
+              "name": "componentOnReady",
+              "return": {
+                "type": {
+                  "text": "Promise<void>",
+                  "references": [
+                    {
+                      "module": "lib/lib.es5.d.ts",
+                      "name": "Promise",
+                      "package": "typescript",
+                      "start": 0,
+                      "end": 7
+                    }
+                  ]
+                }
+              },
+              "description": "Create a promise that resolves once component is fully loaded.",
+              "signature": "(): Promise<void>",
+              "async": true,
+              "inheritedFrom": {
+                "name": "LitElement",
+                "package": "@arcgis/lumina"
+              },
+              "docsTags": [
+                {
+                  "name": "example",
+                  "text": "```js\nconst arcgisTextCard = document.querySelector(\"arcgis-text-card\");\ndocument.body.append(arcgisTextCard);\nawait arcgisTextCard.componentOnReady();\nconsole.log(\"arcgis-text-card is ready to go!\");\n```"
+                }
+              ]
+            },
+            {
+              "kind": "field",
+              "name": "html",
+              "description": "The HTML content to display - this will be\nsanitized before rendering.",
+              "type": {
+                "text": "string",
+                "values": [
+                  {
+                    "type": "string"
+                  }
+                ]
+              },
+              "default": "\"\"",
+              "attribute": "html"
+            },
+            {
+              "kind": "field",
+              "name": "nodeConfig",
+              "type": {
+                "text": "ILayoutNodeConfig",
+                "references": [
+                  {
+                    "name": "ILayoutNodeConfig",
+                    "module": "dist/components/layouts/types.d.ts",
+                    "start": 0,
+                    "end": 17
+                  }
+                ]
+              },
+              "readonly": true
+            }
+          ],
+          "attributes": [
+            {
+              "name": "html",
+              "description": "The HTML content to display - this will be\nsanitized before rendering.",
+              "type": {
+                "text": "string",
+                "values": [
+                  {
+                    "type": "string"
+                  }
+                ]
+              },
+              "default": "\"\"",
+              "fieldName": "html"
+            }
+          ]
+        }
+      ],
+      "exports": [
+        {
+          "kind": "custom-element-definition",
+          "name": "arcgis-text-card",
+          "declaration": {
+            "name": "ArcgisTextCard",
+            "module": "src/components/text-card/text-card.tsx"
           }
         }
       ]