@esri/hub-web-components 0.17.0 → 0.19.0

package/dist/docs/docs.json

@@ -1,5 +1,5 @@
 {
-  "timestamp": "2026-01-21T23:16:30",
+  "timestamp": "2026-01-28T14:21:59",
   "compiler": {
     "name": "@arcgis/lumina-compiler",
     "version": "4.33.24",
@@ -264,28 +264,6 @@
       "dependencies": [],
       "dependencyGraph": {},
       "props": [
-        {
-          "name": "authentication",
-          "type": "ArcGISIdentityManager",
-          "complexType": {
-            "original": "ArcGISIdentityManager",
-            "resolved": "ArcGISIdentityManager",
-            "references": {
-              "ArcGISIdentityManager": {
-                "location": "import",
-                "path": "@esri/arcgis-rest-request/dist/esm/ArcGISIdentityManager.d.ts",
-                "id": "notImplemented"
-              }
-            }
-          },
-          "mutable": true,
-          "reflectToAttr": false,
-          "docs": "The authentication manager for ArcGIS API requests.",
-          "docsTags": [],
-          "values": [],
-          "optional": true,
-          "required": false
-        },
         {
           "name": "botDescription",
           "type": "string",
@@ -461,28 +439,6 @@
           "optional": true,
           "required": false
         },
-        {
-          "name": "hasOrgAiAccess",
-          "type": "boolean",
-          "complexType": {
-            "original": "boolean",
-            "resolved": "boolean",
-            "references": {}
-          },
-          "mutable": true,
-          "attr": "has-org-ai-access",
-          "reflectToAttr": false,
-          "docs": "",
-          "docsTags": [],
-          "default": "false",
-          "values": [
-            {
-              "type": "boolean"
-            }
-          ],
-          "optional": true,
-          "required": false
-        },
         {
           "name": "inputText",
           "type": "string",
@@ -504,50 +460,6 @@
           ],
           "optional": true,
           "required": false
-        },
-        {
-          "name": "isAuthenticated",
-          "type": "boolean",
-          "complexType": {
-            "original": "boolean",
-            "resolved": "boolean",
-            "references": {}
-          },
-          "mutable": true,
-          "attr": "is-authenticated",
-          "reflectToAttr": false,
-          "docs": "",
-          "docsTags": [],
-          "default": "false",
-          "values": [
-            {
-              "type": "boolean"
-            }
-          ],
-          "optional": true,
-          "required": false
-        },
-        {
-          "name": "portalUrl",
-          "type": "string",
-          "complexType": {
-            "original": "string",
-            "resolved": "string",
-            "references": {}
-          },
-          "mutable": true,
-          "attr": "portal-url",
-          "reflectToAttr": false,
-          "docs": "",
-          "docsTags": [],
-          "default": "\"https://www.arcgis.com\"",
-          "values": [
-            {
-              "type": "string"
-            }
-          ],
-          "optional": true,
-          "required": false
         }
       ],
       "methods": [
@@ -783,28 +695,6 @@
           "optional": true,
           "required": false
         },
-        {
-          "name": "authentication",
-          "type": "ArcGISIdentityManager",
-          "complexType": {
-            "original": "ArcGISIdentityManager",
-            "resolved": "ArcGISIdentityManager",
-            "references": {
-              "ArcGISIdentityManager": {
-                "location": "import",
-                "path": "@esri/arcgis-rest-request/dist/esm/ArcGISIdentityManager.d.ts",
-                "id": "notImplemented"
-              }
-            }
-          },
-          "mutable": true,
-          "reflectToAttr": false,
-          "docs": "",
-          "docsTags": [],
-          "values": [],
-          "optional": true,
-          "required": false
-        },
         {
           "name": "botDescription",
           "type": "string",
@@ -1128,28 +1018,6 @@
           ],
           "optional": true,
           "required": false
-        },
-        {
-          "name": "portalUrl",
-          "type": "string",
-          "complexType": {
-            "original": "string",
-            "resolved": "string",
-            "references": {}
-          },
-          "mutable": true,
-          "attr": "portal-url",
-          "reflectToAttr": false,
-          "docs": "The base URL of the ArcGIS portal to use for authentication and data requests.",
-          "docsTags": [],
-          "default": "\"https://www.arcgis.com\"",
-          "values": [
-            {
-              "type": "string"
-            }
-          ],
-          "optional": true,
-          "required": false
         }
       ],
       "methods": [
@@ -1877,7 +1745,7 @@
       "overview": "",
       "readme": "",
       "usage": {},
-      "docs": "Component that renders a Hub entity view\nusing the layout system.",
+      "docs": "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.",
       "docsTags": [
         {
           "name": "superclass",
@@ -2064,7 +1932,7 @@
           },
           "cancelable": true,
           "composed": true,
-          "docs": "Event emitted when the layout is published.\nNote: only relevant for entities that are\nrendered via a layout.",
+          "docs": "Event emitted when the layout is published.",
           "docsTags": []
         },
         {
@@ -2087,115 +1955,13 @@
       "parts": [],
       "listeners": []
     },
-    {
-      "filePath": "src/components/layouts/components/layout-node-overlay/layout-node-overlay.tsx",
-      "tag": "arcgis-layout-node-overlay",
-      "overview": "",
-      "readme": "",
-      "usage": {},
-      "docs": "A component for rendering overlay content on\nlayout nodes. Overlays are used to indicate\nspecial states of layout nodes (e.g., hidden).",
-      "docsTags": [
-        {
-          "name": "superclass",
-          "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}"
-        }
-      ],
-      "encapsulation": "shadow",
-      "dependents": [],
-      "dependencies": [],
-      "dependencyGraph": {},
-      "props": [
-        {
-          "name": "nodeId",
-          "type": "string",
-          "complexType": {
-            "original": "string",
-            "resolved": "string",
-            "references": {}
-          },
-          "mutable": true,
-          "attr": "node-id",
-          "reflectToAttr": false,
-          "docs": "The ID of the layout node this overlay\nis anchored to.",
-          "docsTags": [],
-          "values": [
-            {
-              "type": "string"
-            }
-          ],
-          "optional": true,
-          "required": false
-        },
-        {
-          "name": "type",
-          "type": "\"hidden\"",
-          "complexType": {
-            "original": "\"hidden\"",
-            "resolved": "\"hidden\"",
-            "references": {}
-          },
-          "mutable": true,
-          "attr": "type",
-          "reflectToAttr": false,
-          "docs": "The type of overlay to display. For now, we'll\nsupport a predefined set of overlay types\n(rather than allowing content to be slotted\nin) to keep the UI consistent, and to\nsimplify implementation.\n\nAdd additional types as needed.",
-          "docsTags": [],
-          "values": [
-            {
-              "value": "hidden",
-              "type": "string"
-            }
-          ],
-          "optional": true,
-          "required": false
-        }
-      ],
-      "methods": [
-        {
-          "name": "componentOnReady",
-          "returns": {
-            "type": "Promise<void>",
-            "docs": ""
-          },
-          "complexType": {
-            "signature": "(): Promise<void>",
-            "parameters": [],
-            "return": "Promise<void>",
-            "references": {
-              "Promise": {
-                "location": "import",
-                "path": "typescript/lib/lib.es5.d.ts",
-                "id": "notImplemented"
-              }
-            }
-          },
-          "signature": "componentOnReady(): Promise<void>",
-          "parameters": [],
-          "docs": "Create a promise that resolves once component is fully loaded.",
-          "docsTags": [
-            {
-              "name": "example",
-              "text": "```js\nconst arcgisLayoutNodeOverlay = document.querySelector(\"arcgis-layout-node-overlay\");\ndocument.body.append(arcgisLayoutNodeOverlay);\nawait arcgisLayoutNodeOverlay.componentOnReady();\nconsole.log(\"arcgis-layout-node-overlay is ready to go!\");\n```"
-            },
-            {
-              "name": "inheritedFrom",
-              "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}"
-            }
-          ]
-        }
-      ],
-      "events": [],
-      "styles": [],
-      "slots": [],
-      "parts": [],
-      "listeners": []
-    },
     {
       "filePath": "src/components/layouts/layout/layout.tsx",
       "tag": "arcgis-layout",
       "overview": "",
       "readme": "",
       "usage": {},
-      "docs": "A web component for rendering an ILayout",
+      "docs": "Web component for rendering an ILayout. Orchestrates\nthe rendering of sections, rows, columns, and cards\nas defined by the layout JSON.",
       "docsTags": [
         {
           "name": "superclass",
@@ -2218,7 +1984,7 @@
           "mutable": true,
           "attr": "debug",
           "reflectToAttr": true,
-          "docs": "Enables debug mode",
+          "docs": "Enables debug mode.",
           "docsTags": [],
           "default": "false",
           "values": [
@@ -2245,7 +2011,7 @@
           },
           "mutable": true,
           "reflectToAttr": false,
-          "docs": "The currently focused/hovered node. This is\ntracked in order to show the node's configuration\ncontrols and \"active\" state in the UI.",
+          "docs": "The currently focused/hovered node. Used to show\nconfiguration controls and active state in the UI.",
           "docsTags": [],
           "values": [],
           "optional": true,
@@ -2262,7 +2028,7 @@
           "mutable": true,
           "attr": "is-edit-mode",
           "reflectToAttr": true,
-          "docs": "Whether the layout is in edit mode",
+          "docs": "Whether the layout is in edit mode.",
           "docsTags": [],
           "default": "false",
           "values": [
@@ -2289,7 +2055,7 @@
           },
           "mutable": true,
           "reflectToAttr": false,
-          "docs": "The layout to render",
+          "docs": "The layout to render.",
           "docsTags": [],
           "values": [],
           "optional": true,
@@ -2311,7 +2077,7 @@
           },
           "mutable": true,
           "reflectToAttr": false,
-          "docs": "Options for processing the layout",
+          "docs": "Options for processing the layout.",
           "docsTags": [],
           "values": [],
           "optional": true,
@@ -2355,7 +2121,7 @@
           "name": "getCardEl",
           "returns": {
             "type": "Promise<(HTMLElement & IConfigurableLayoutNode) | undefined>",
-            "docs": ""
+            "docs": "The HTML element for the node, if found"
           },
           "complexType": {
             "signature": "(nodeId: string): Promise<HTMLConfigurableLayoutNodeElement | undefined>",
@@ -2393,8 +2159,17 @@
               "docs": ""
             }
           ],
-          "docs": "",
-          "docsTags": []
+          "docs": "Public method that returns the DOM element for a\nlayout node by id. Used for highlighting or\nscrolling to a node in the layout.",
+          "docsTags": [
+            {
+              "name": "param",
+              "text": "nodeId - The id of the node"
+            },
+            {
+              "name": "returns",
+              "text": "The HTML element for the node, if found"
+            }
+          ]
         }
       ],
       "events": [
@@ -2409,7 +2184,7 @@
           },
           "cancelable": true,
           "composed": true,
-          "docs": "",
+          "docs": "Event emitted when the layout has finished\nrendering.",
           "docsTags": []
         }
       ],
@@ -2426,6 +2201,10 @@
       "usage": {},
       "docs": "",
       "docsTags": [
+        {
+          "name": "internal",
+          "text": "Main container component for rendering and managing\nan ILayout and its nodes. Orchestrates layout\ncomposition, editing, and interaction logic."
+        },
         {
           "name": "superclass",
           "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}"
@@ -2491,7 +2270,7 @@
           "mutable": true,
           "attr": "is-publishing",
           "reflectToAttr": false,
-          "docs": "Whether the layout is currently being\npublished.",
+          "docs": "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.",
           "docsTags": [],
           "default": "false",
           "values": [
@@ -2605,7 +2384,7 @@
           },
           "cancelable": true,
           "composed": true,
-          "docs": "",
+          "docs": "Event emitted when the layout is edited",
           "docsTags": []
         },
         {
@@ -2619,7 +2398,7 @@
           },
           "cancelable": true,
           "composed": true,
-          "docs": "",
+          "docs": "Event emitted when the layout editor is exited",
           "docsTags": []
         },
         {

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

@@ -48,22 +48,10 @@
           "name": "domain",
           "values": []
         },
-        {
-          "name": "has-org-ai-access",
-          "values": []
-        },
         {
           "name": "input-text",
           "description": "The current text input value from the user.",
           "values": []
-        },
-        {
-          "name": "is-authenticated",
-          "values": []
-        },
-        {
-          "name": "portal-url",
-          "values": []
         }
       ],
       "references": []
@@ -136,11 +124,6 @@
           "name": "map-visible",
           "description": "If the map is currently visible. Only applicable if `mapEnabled` is true.",
           "values": []
-        },
-        {
-          "name": "portal-url",
-          "description": "The base URL of the ArcGIS portal to use for authentication and data requests.",
-          "values": []
         }
       ],
       "references": []
@@ -217,7 +200,7 @@
     },
     {
       "name": "arcgis-hub-entity-view-layout",
-      "description": "Component that renders a Hub entity view\nusing the layout system.\n--\n\n### Events\n- **arcgisHubEntityViewPublished** - Event emitted when the layout is published.\nNote: only relevant for entities that are\nrendered via a layout.\n- **hubTelemetry** - Event emitted for telemetry\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.",
+      "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",
@@ -227,39 +210,18 @@
       ],
       "references": []
     },
-    {
-      "name": "arcgis-layout-node-overlay",
-      "description": "A component for rendering overlay content on\nlayout nodes. Overlays are used to indicate\nspecial states of layout nodes (e.g., hidden).\n--\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.",
-      "attributes": [
-        {
-          "name": "node-id",
-          "description": "The ID of the layout node this overlay\nis anchored to.",
-          "values": []
-        },
-        {
-          "name": "type",
-          "description": "The type of overlay to display. For now, we'll\nsupport a predefined set of overlay types\n(rather than allowing content to be slotted\nin) to keep the UI consistent, and to\nsimplify implementation.\n\nAdd additional types as needed.",
-          "values": [
-            {
-              "name": "hidden"
-            }
-          ]
-        }
-      ],
-      "references": []
-    },
     {
       "name": "arcgis-layout",
-      "description": "A web component for rendering an ILayout\n--\n\n### Events\n- **arcgisHubLayoutRendered**\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `getCardEl(nodeId: string): Promise<HTMLConfigurableLayoutNodeElement | undefined>`",
+      "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",
+          "description": "Enables debug mode.",
           "values": []
         },
         {
           "name": "is-edit-mode",
-          "description": "Whether the layout is in edit mode",
+          "description": "Whether the layout is in edit mode.",
           "values": []
         }
       ],
@@ -267,7 +229,7 @@
     },
     {
       "name": "arcgis-layout-container",
-      "description": "### Events\n- **arcgisHubLayoutChanged**\n- **arcgisHubLayoutEditorExit**\n- **arcgisHubLayoutPublished** - 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.",
+      "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- **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",
@@ -280,7 +242,7 @@
         },
         {
           "name": "is-publishing",
-          "description": "Whether the layout is currently being\npublished.",
+          "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": []
         }
       ],