@esri/hub-web-components 0.0.8 → 0.1.0

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

@@ -0,0 +1,11 @@
+/**
+ * TODO: Consider hoisting to hub-common
+ *
+ * Deep freeze an object, effectively making it immutable.
+ * This is useful for ensuring that the layout object cannot
+ * be modified after it has been processed.
+ * @template T The type of the object to deep freeze.
+ * @param obj The object to deep freeze.
+ * @returns The deep-frozen object.
+ */
+export declare function deepFreeze<T>(obj: T): T;

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

@@ -0,0 +1,6 @@
+import { ColumnWidth, IColumnProps, ISectionProps, IRowProps, ResponsiveValue } from '../types';
+export declare function getResponsiveClasses<T>(propName: string, value: ResponsiveValue<T> | undefined, valueMapper?: (val: T) => string): string[];
+export declare function getSectionClasses(props?: ISectionProps): string[];
+export declare function getRowClasses(props?: IRowProps): string[];
+export declare function getColumnWidthClasses(width: ResponsiveValue<ColumnWidth> | undefined): string[];
+export declare function getColumnClasses(props?: IColumnProps): string[];

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

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

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

@@ -0,0 +1,3 @@
+import { IArcGISContext } from '@esri/hub-common';
+import { ILayout, IProcessLayoutOptions } from '../types';
+export declare const processLayout: (layout: ILayout, options: IProcessLayoutOptions, context: IArcGISContext) => Promise<Promise<ILayout>>;

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

@@ -0,0 +1,25 @@
+import { IColumn, IRow, ISection, LayoutNode, Ref, SectionOrRef } from '../types';
+/**
+ * Type guard to check if a node is a section.
+ * @param node
+ * @returns True if the node is a section, false otherwise.
+ */
+export declare function isSection(node: LayoutNode): node is ISection;
+/**
+ * Type guard to check if a node is a row.
+ * @param node
+ * @returns True if the node is a row, false otherwise.
+ */
+export declare function isRow(node: LayoutNode): node is IRow;
+/**
+ * Type guard to check if a node is a column.
+ * @param node
+ * @returns True if the nod is a column, false otherwise.
+ */
+export declare function isColumn(node: LayoutNode): node is IColumn;
+/**
+ * Checks if a section is a reference.
+ * @param section The section to check.
+ * @returns True if the section is a reference, false otherwise.
+ */
+export declare function isRef(section: SectionOrRef | undefined): section is Ref;

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

@@ -0,0 +1,7 @@
+import { ILayout } from '../types';
+/**
+ * Validates a layout tree for required structure, types,
+ * and correct nesting. Returns an array of error messages,
+ * or an empty array if valid.
+ */
+export declare function validateLayout(layout: ILayout | undefined): string[];

package/dist/docs/api.json

@@ -1,12 +1,102 @@
 {
-  "timestamp": "2025-08-29T18:13:12",
+  "timestamp": "2025-09-16T14:41:02",
   "compiler": {
     "name": "@arcgis/lumina-compiler",
-    "version": "4.33.0-next.121",
+    "version": "4.33.19",
     "typescriptVersion": "5.8.3"
   },
   "schemaVersion": "1.0.0",
   "modules": [
+    {
+      "kind": "javascript-module",
+      "path": "src/components/arcgis-text-element/arcgis-text-element.tsx",
+      "declarations": [
+        {
+          "kind": "class",
+          "customElement": true,
+          "name": "ArcgisTextElement",
+          "tagName": "arcgis-text-element",
+          "superclass": {
+            "name": "LitElement",
+            "package": "@arcgis/lumina"
+          },
+          "pascalCaseName": "ArcgisTextElement",
+          "importPath": "components/arcgis-text-element",
+          "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 arcgisTextElement = document.querySelector(\"arcgis-text-element\");\ndocument.body.append(arcgisTextElement);\nawait arcgisTextElement.componentOnReady();\nconsole.log(\"arcgis-text-element is ready to go!\");\n```"
+                }
+              ]
+            },
+            {
+              "kind": "field",
+              "name": "html",
+              "type": {
+                "text": "string",
+                "values": [
+                  {
+                    "type": "string"
+                  }
+                ]
+              },
+              "default": "\"\"",
+              "attribute": "html"
+            }
+          ],
+          "attributes": [
+            {
+              "name": "html",
+              "type": {
+                "text": "string",
+                "values": [
+                  {
+                    "type": "string"
+                  }
+                ]
+              },
+              "default": "\"\"",
+              "fieldName": "html"
+            }
+          ]
+        }
+      ],
+      "exports": [
+        {
+          "kind": "custom-element-definition",
+          "name": "arcgis-text-element",
+          "declaration": {
+            "name": "ArcgisTextElement",
+            "module": "src/components/arcgis-text-element/arcgis-text-element.tsx"
+          }
+        }
+      ]
+    },
     {
       "kind": "javascript-module",
       "path": "src/components/chat-shell/chat-shell.tsx",
@@ -85,7 +175,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 +305,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"
+                }
+              ]
             }
           ]
         }
@@ -303,7 +406,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```"
                 }
               ]
             },
@@ -440,6 +543,22 @@
                       }
                     ]
                   }
+                },
+                {
+                  "name": "type",
+                  "type": {
+                    "text": "\"query\" | \"suggest\"",
+                    "values": [
+                      {
+                        "value": "query",
+                        "type": "string"
+                      },
+                      {
+                        "value": "suggest",
+                        "type": "string"
+                      }
+                    ]
+                  }
                 }
               ],
               "return": {
@@ -461,7 +580,7 @@
                   "text": "text The user's input message."
                 }
               ],
-              "signature": "(text: string): void"
+              "signature": "(text: string, type: \"query\" | \"suggest\"): void"
             }
           ],
           "attributes": [
@@ -543,6 +662,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 +795,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,13 +1219,161 @@
               "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/arcgis-layout/arcgis-layout.tsx",
+      "declarations": [
+        {
+          "kind": "class",
+          "customElement": true,
+          "name": "ArcgisLayout",
+          "tagName": "arcgis-layout",
+          "description": "This is a web component that renders a ILayout.",
+          "superclass": {
+            "name": "LitElement",
+            "package": "@arcgis/lumina"
+          },
+          "pascalCaseName": "ArcgisLayout",
+          "importPath": "components/arcgis-layout",
+          "members": [
             {
-              "name": "arcgisAddLayer",
+              "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": "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": "undefined"
+                "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",
+              "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"
             }
           ]
         }
@@ -1101,10 +1381,71 @@
       "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/arcgis-layout/arcgis-layout.tsx"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/components/layouts/arcgis-layout-container/arcgis-layout-container.tsx",
+      "declarations": [
+        {
+          "kind": "class",
+          "customElement": true,
+          "name": "ArcgisLayoutContainer",
+          "tagName": "arcgis-layout-container",
+          "superclass": {
+            "name": "LitElement",
+            "package": "@arcgis/lumina"
+          },
+          "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```"
+                }
+              ]
+            }
+          ]
+        }
+      ],
+      "exports": [
+        {
+          "kind": "custom-element-definition",
+          "name": "arcgis-layout-container",
+          "declaration": {
+            "name": "ArcgisLayoutContainer",
+            "module": "src/components/layouts/arcgis-layout-container/arcgis-layout-container.tsx"
           }
         }
       ]