@esri/hub-web-components 0.17.0 → 0.19.0

package/dist/components/layouts/utils/findColumnAndNodeIndex.d.ts

@@ -6,10 +6,14 @@ export interface ColumnNodeLocation {
     isLastInColumn: boolean;
 }
 /**
- * Recursively traverses the layout to find the IColumn containing the given LayoutNode,
- * and returns the column and the index of the node within that column.
- * @param targetNode The LayoutNode to find
- * @param layout The ILayout to search
- * @returns {ColumnNodeLocation | undefined} The column and index, or undefined if not found
+ * Recursively traverses a layout to find the column
+ * containing a given node, returning the column and
+ * the index of the node within that column. Handles
+ * nested structures, including nav-card sections and
+ * rows within columns.
+ *
+ * @param targetNode - The LayoutNode to locate within the layout structure.
+ * @param layout - The ILayout object to search.
+ * @returns {ColumnNodeLocation | undefined} The column and index if found, or undefined if not found.
  */
 export declare function findColumnAndNodeIndex(targetNode: LayoutNode, layout: ILayout): ColumnNodeLocation | undefined;

package/dist/components/layouts/utils/findNodeById.d.ts

@@ -1,8 +1,10 @@
 import { ILayout, LayoutNode } from '@esri/hub-common';
 /**
- * Recursively traverses the layout to find the LayoutNode with the given id.
- * @param layout The ILayout to search
- * @param nodeId The id of the LayoutNode to find
- * @returns {LayoutNode | undefined} The LayoutNode, or undefined if not found
+ * Recursively traverses a layout to find a node
+ * with a given id.
+ *
+ * @param layout - The ILayout object to search for the node.
+ * @param nodeId - The id of the LayoutNode to find.
+ * @returns {LayoutNode | undefined} The layout node, or undefined if not found.
  */
 export declare function findNodeById(layout: ILayout, nodeId: string): LayoutNode | undefined;

package/dist/components/layouts/utils/getAddableLayoutNodes.d.ts

@@ -9,4 +9,14 @@ export interface IAddLayoutNodeConfiguration {
     telemetry?: Record<string, unknown>;
 }
 export declare const layoutNodeConfig: IAddLayoutNodeConfiguration[];
+/**
+ * Memoized async function that returns addable layout
+ * node configurations, filtered and interpolated for
+ * the current context and options.
+ *
+ * @param _layout - The layout to process (not currently used, but reserved for future logic).
+ * @param options - Options for processing, including translations and entity context.
+ * @param context - contextual portal & auth information for permission checks and interpolation.
+ * @returns {Promise<IAddLayoutNodeConfiguration[]>} Promise resolving to the list of addable node configurations.
+ */
 export declare const getAddableLayoutNodes: (_layout: import('@esri/hub-common').ILayoutV2, options: Record<string, unknown>, context: IArcGISContext) => Promise<Promise<IAddLayoutNodeConfiguration[]>>;

package/dist/components/layouts/utils/getResponsiveClasses.d.ts

@@ -1,6 +1,44 @@
 import { ColumnWidth, ResponsiveValue, ISection, IRow, IColumn } from '@esri/hub-common';
+/**
+ * Generates responsive CSS classes based on the provided
+ * property name and its value(s).
+ *
+ * @param propName - The name of the property for which to generate classes
+ * @param value - The responsive value(s) for the property
+ * @param valueMapper - Optional function to map the value to a string
+ * @returns An array of CSS classes
+ * @example
+ * getResponsiveClasses('col', { xs: 12, md: 6 }); => ['col-12', 'col-md-6']
+ * getResponsiveClasses('align-items', true); => ['align-items']
+ * getResponsiveClasses('offset', 3); => ['offset-3']
+ * getResponsiveClasses('custom-prop', "some-value", (val) => val.toUpperCase()); => ['custom-prop-SOME-VALUE']
+ */
 export declare function getResponsiveClasses<T>(propName: string, value: ResponsiveValue<T> | undefined, valueMapper?: (val: T) => string): string[];
+/**
+ * Helper to build CSS classes for a section node.
+ *
+ * @param section - The section node
+ * @returns An array of classes to apply to the section node
+ */
 export declare function getSectionClasses(section: ISection): string[];
+/**
+ * Helper to build CSS classes for a row node.
+ *
+ * @param row - The row node
+ * @returns An array of classes to apply to the row node
+ */
 export declare function getRowClasses(row: IRow): string[];
+/**
+ * Helper to build CSS classes for column width.
+ *
+ * @param width - The column width responsive value
+ * @returns An array of classes to apply for the column width
+ */
 export declare function getColumnWidthClasses(width: ResponsiveValue<ColumnWidth> | undefined): string[];
+/**
+ * Helper to build CSS classes for a column node.
+ *
+ * @param column - The column node
+ * @returns An array of classes to apply to the column node
+ */
 export declare function getColumnClasses(column: IColumn): string[];

package/dist/components/layouts/utils/layoutContext.d.ts

@@ -1,9 +1,15 @@
 import { ArcgisLayoutContainer } from '../../arcgis-layout-container/customElement.js';
 import { ILayout } from '@esri/hub-common';
-export type LayoutContext = {
-    messages: ArcgisLayoutContainer["_messages"];
-    layout: ILayout | undefined;
-};
+/**
+ * Lumina Context for sharing layout information from
+ * the layout container to child components without
+ * needing to prop drill.
+ */
 export declare const layoutContext: {
-    __context__: LayoutContext;
+    __context__: {
+        /** localized messages from the layout container */
+        messages: ArcgisLayoutContainer["_messages"];
+        /** the processed layout */
+        layout: ILayout | undefined;
+    };
 };

package/dist/components/layouts/utils/lockLayout.d.ts

@@ -1,8 +1,9 @@
 import { ILayout } from '@esri/hub-common';
 /**
- * Utility that walks through the layout and lock all nodes
+ * Utility that walks through the layout and locks all nodes
  * by setting readOnly to true.
- * @param layout The layout to process.
- * @returns The processed layout.
+ *
+ * @param layout - The layout to lock.
+ * @returns The locked layout.
  */
 export declare function lockLayout(layout: ILayout): ILayout;

package/dist/components/layouts/utils/memoizeAsync.d.ts

@@ -1,6 +1,7 @@
 /**
  * Simple memoization for async functions.
- * @param fn The async function to memoize
+ *
+ * @param fn - The async function to memoize
  * @returns A memoized version of the async function
  */
 export declare function memoizeAsync<T extends (...args: any[]) => Promise<unknown>>(fn: T): (...args: Parameters<T>) => Promise<ReturnType<T>>;

package/dist/controllers/useGlobalContext.d.ts

@@ -0,0 +1,6 @@
+import { LitElement } from '@arcgis/lumina';
+import { IArcGISContext } from '@esri/hub-common';
+/**
+ * Controller to manage and expose the global ArcGIS context reflexively to Lumina-based web components.
+ */
+export declare const useGlobalContext: (component: import('@esri/hub-components').IWithContext & LitElement) => IArcGISContext;

package/dist/docs/api.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",
@@ -257,23 +257,6 @@
           "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",
@@ -452,20 +435,6 @@
                 }
               ]
             },
-            {
-              "kind": "field",
-              "name": "hasOrgAiAccess",
-              "type": {
-                "text": "boolean",
-                "values": [
-                  {
-                    "type": "boolean"
-                  }
-                ]
-              },
-              "default": "false",
-              "attribute": "has-org-ai-access"
-            },
             {
               "kind": "field",
               "name": "inputText",
@@ -481,34 +450,6 @@
               "default": "\"\"",
               "attribute": "input-text"
             },
-            {
-              "kind": "field",
-              "name": "isAuthenticated",
-              "type": {
-                "text": "boolean",
-                "values": [
-                  {
-                    "type": "boolean"
-                  }
-                ]
-              },
-              "default": "false",
-              "attribute": "is-authenticated"
-            },
-            {
-              "kind": "field",
-              "name": "portalUrl",
-              "type": {
-                "text": "string",
-                "values": [
-                  {
-                    "type": "string"
-                  }
-                ]
-              },
-              "default": "\"https://www.arcgis.com\"",
-              "attribute": "portal-url"
-            },
             {
               "kind": "method",
               "name": "submitUserMessage",
@@ -629,19 +570,6 @@
               "default": "\"hub.arcgis.com\"",
               "fieldName": "domain"
             },
-            {
-              "name": "has-org-ai-access",
-              "type": {
-                "text": "boolean",
-                "values": [
-                  {
-                    "type": "boolean"
-                  }
-                ]
-              },
-              "default": "false",
-              "fieldName": "hasOrgAiAccess"
-            },
             {
               "name": "input-text",
               "description": "The current text input value from the user.",
@@ -655,32 +583,6 @@
               },
               "default": "\"\"",
               "fieldName": "inputText"
-            },
-            {
-              "name": "is-authenticated",
-              "type": {
-                "text": "boolean",
-                "values": [
-                  {
-                    "type": "boolean"
-                  }
-                ]
-              },
-              "default": "false",
-              "fieldName": "isAuthenticated"
-            },
-            {
-              "name": "portal-url",
-              "type": {
-                "text": "string",
-                "values": [
-                  {
-                    "type": "string"
-                  }
-                ]
-              },
-              "default": "\"https://www.arcgis.com\"",
-              "fieldName": "portalUrl"
             }
           ],
           "events": [
@@ -795,22 +697,6 @@
               "default": "\"/api/assistants/v1\"",
               "attribute": "api-url"
             },
-            {
-              "kind": "field",
-              "name": "authentication",
-              "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",
@@ -1080,21 +966,6 @@
               },
               "default": "false",
               "attribute": "map-visible"
-            },
-            {
-              "kind": "field",
-              "name": "portalUrl",
-              "description": "The base URL of the ArcGIS portal to use for authentication and data requests.",
-              "type": {
-                "text": "string",
-                "values": [
-                  {
-                    "type": "string"
-                  }
-                ]
-              },
-              "default": "\"https://www.arcgis.com\"",
-              "attribute": "portal-url"
             }
           ],
           "attributes": [
@@ -1273,20 +1144,6 @@
               },
               "default": "false",
               "fieldName": "mapVisible"
-            },
-            {
-              "name": "portal-url",
-              "description": "The base URL of the ArcGIS portal to use for authentication and data requests.",
-              "type": {
-                "text": "string",
-                "values": [
-                  {
-                    "type": "string"
-                  }
-                ]
-              },
-              "default": "\"https://www.arcgis.com\"",
-              "fieldName": "portalUrl"
             }
           ]
         }
@@ -2086,7 +1943,7 @@
           "customElement": true,
           "name": "ArcgisHubEntityViewLayout",
           "tagName": "arcgis-hub-entity-view-layout",
-          "description": "Component that renders a Hub entity view\nusing the layout system.",
+          "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.",
           "superclass": {
             "name": "LitElement",
             "package": "@arcgis/lumina"
@@ -2283,7 +2140,7 @@
           "events": [
             {
               "name": "arcgisHubEntityViewPublished",
-              "description": "Event emitted when the layout is published.\nNote: only relevant for entities that are\nrendered via a layout.",
+              "description": "Event emitted when the layout is published.",
               "type": {
                 "text": "void"
               }
@@ -2309,126 +2166,6 @@
         }
       ]
     },
-    {
-      "kind": "javascript-module",
-      "path": "src/components/layouts/components/layout-node-overlay/layout-node-overlay.tsx",
-      "declarations": [
-        {
-          "kind": "class",
-          "customElement": true,
-          "name": "ArcgisLayoutNodeOverlay",
-          "tagName": "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).",
-          "superclass": {
-            "name": "LitElement",
-            "package": "@arcgis/lumina"
-          },
-          "pascalCaseName": "ArcgisLayoutNodeOverlay",
-          "importPath": "components/arcgis-layout-node-overlay",
-          "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 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```"
-                }
-              ]
-            },
-            {
-              "kind": "field",
-              "name": "nodeId",
-              "description": "The ID of the layout node this overlay\nis anchored to.",
-              "type": {
-                "text": "string",
-                "values": [
-                  {
-                    "type": "string"
-                  }
-                ]
-              },
-              "attribute": "node-id"
-            },
-            {
-              "kind": "field",
-              "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.",
-              "type": {
-                "text": "\"hidden\"",
-                "values": [
-                  {
-                    "value": "hidden",
-                    "type": "string"
-                  }
-                ]
-              },
-              "attribute": "type"
-            }
-          ],
-          "attributes": [
-            {
-              "name": "node-id",
-              "description": "The ID of the layout node this overlay\nis anchored to.",
-              "type": {
-                "text": "string",
-                "values": [
-                  {
-                    "type": "string"
-                  }
-                ]
-              },
-              "fieldName": "nodeId"
-            },
-            {
-              "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.",
-              "type": {
-                "text": "\"hidden\"",
-                "values": [
-                  {
-                    "value": "hidden",
-                    "type": "string"
-                  }
-                ]
-              },
-              "fieldName": "type"
-            }
-          ]
-        }
-      ],
-      "exports": [
-        {
-          "kind": "custom-element-definition",
-          "name": "arcgis-layout-node-overlay",
-          "declaration": {
-            "name": "ArcgisLayoutNodeOverlay",
-            "module": "src/components/layouts/components/layout-node-overlay/layout-node-overlay.tsx"
-          }
-        }
-      ]
-    },
     {
       "kind": "javascript-module",
       "path": "src/components/layouts/layout/layout.tsx",
@@ -2438,7 +2175,7 @@
           "customElement": true,
           "name": "ArcgisLayout",
           "tagName": "arcgis-layout",
-          "description": "A web component for rendering an ILayout",
+          "description": "Web component for rendering an ILayout. Orchestrates\nthe rendering of sections, rows, columns, and cards\nas defined by the layout JSON.",
           "superclass": {
             "name": "LitElement",
             "package": "@arcgis/lumina"
@@ -2480,7 +2217,7 @@
             {
               "kind": "field",
               "name": "debug",
-              "description": "Enables debug mode",
+              "description": "Enables debug mode.",
               "type": {
                 "text": "boolean",
                 "values": [
@@ -2496,6 +2233,7 @@
             {
               "kind": "method",
               "name": "getCardEl",
+              "description": "Public method that returns the DOM element for a\nlayout node by id. Used for highlighting or\nscrolling to a node in the layout.",
               "parameters": [
                 {
                   "name": "nodeId",
@@ -2538,13 +2276,23 @@
                   ]
                 }
               },
+              "docsTags": [
+                {
+                  "name": "param",
+                  "text": "nodeId - The id of the node"
+                },
+                {
+                  "name": "returns",
+                  "text": "The HTML element for the node, if found"
+                }
+              ],
               "signature": "(nodeId: string): Promise<HTMLConfigurableLayoutNodeElement | undefined>",
               "async": true
             },
             {
               "kind": "field",
               "name": "highlightedNode",
-              "description": "The currently focused/hovered node. This is\ntracked in order to show the node's configuration\ncontrols and \"active\" state in the UI.",
+              "description": "The currently focused/hovered node. Used to show\nconfiguration controls and active state in the UI.",
               "type": {
                 "text": "ILayoutNode",
                 "references": [
@@ -2561,7 +2309,7 @@
             {
               "kind": "field",
               "name": "isEditMode",
-              "description": "Whether the layout is in edit mode",
+              "description": "Whether the layout is in edit mode.",
               "type": {
                 "text": "boolean",
                 "values": [
@@ -2577,7 +2325,7 @@
             {
               "kind": "field",
               "name": "layout",
-              "description": "The layout to render",
+              "description": "The layout to render.",
               "type": {
                 "text": "ILayoutV2",
                 "references": [
@@ -2594,7 +2342,7 @@
             {
               "kind": "field",
               "name": "options",
-              "description": "Options for processing the layout",
+              "description": "Options for processing the layout.",
               "type": {
                 "text": "IProcessLayoutOptions",
                 "references": [
@@ -2612,7 +2360,7 @@
           "attributes": [
             {
               "name": "debug",
-              "description": "Enables debug mode",
+              "description": "Enables debug mode.",
               "type": {
                 "text": "boolean",
                 "values": [
@@ -2626,7 +2374,7 @@
             },
             {
               "name": "is-edit-mode",
-              "description": "Whether the layout is in edit mode",
+              "description": "Whether the layout is in edit mode.",
               "type": {
                 "text": "boolean",
                 "values": [
@@ -2642,6 +2390,7 @@
           "events": [
             {
               "name": "arcgisHubLayoutRendered",
+              "description": "Event emitted when the layout has finished\nrendering.",
               "type": {
                 "text": "void"
               }
@@ -2669,6 +2418,12 @@
           "customElement": true,
           "name": "ArcgisLayoutContainer",
           "tagName": "arcgis-layout-container",
+          "docsTags": [
+            {
+              "name": "internal",
+              "text": "Main container component for rendering and managing\nan ILayout and its nodes. Orchestrates layout\ncomposition, editing, and interaction logic."
+            }
+          ],
           "superclass": {
             "name": "LitElement",
             "package": "@arcgis/lumina"
@@ -2742,7 +2497,7 @@
             {
               "kind": "field",
               "name": "isPublishing",
-              "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.",
               "type": {
                 "text": "boolean",
                 "values": [
@@ -2834,7 +2589,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.",
               "type": {
                 "text": "boolean",
                 "values": [
@@ -2850,12 +2605,14 @@
           "events": [
             {
               "name": "arcgisHubLayoutChanged",
+              "description": "Event emitted when the layout is edited",
               "type": {
                 "text": "void"
               }
             },
             {
               "name": "arcgisHubLayoutEditorExit",
+              "description": "Event emitted when the layout editor is exited",
               "type": {
                 "text": "void"
               }