@esri/solutions-components 1.0.0-next.20250529 → 1.0.0-next.20250530

package/dist/docs/api.json

@@ -1,5 +1,5 @@
 {
-  "timestamp": "2025-05-29T19:36:43",
+  "timestamp": "2025-05-30T17:12:12",
   "compiler": {
     "name": "@arcgis/lumina-compiler",
     "version": "4.33.0-next.147",
@@ -906,7 +906,7 @@
             {
               "kind": "field",
               "name": "showSketchWidgets",
-              "description": "boolean: When true while creating feature Editor's sketch widgets will be displayed",
+              "description": "boolean: When true the sketch widgets will be shown in the create feature component",
               "type": {
                 "text": "boolean",
                 "values": [
@@ -1021,7 +1021,7 @@
             },
             {
               "name": "show-sketch-widgets",
-              "description": "boolean: When true while creating feature Editor's sketch widgets will be displayed",
+              "description": "boolean: When true the sketch widgets will be shown in the create feature component",
               "type": {
                 "text": "boolean",
                 "values": [
@@ -1535,15 +1535,19 @@
             {
               "kind": "method",
               "name": "refresh",
-              "description": "refresh the feature form",
+              "description": "Refreshes the editor state, optionally updating the floor level.",
               "parameters": [
                 {
                   "name": "floorLevel",
+                  "optional": true,
                   "type": {
-                    "text": "string",
+                    "text": "string | undefined",
                     "values": [
                       {
                         "type": "string"
+                      },
+                      {
+                        "type": "undefined"
                       }
                     ]
                   }
@@ -1564,14 +1568,33 @@
                 }
               },
               "docsTags": [
+                {
+                  "name": "param",
+                  "text": "floorLevel - (Optional) The floor level to set. If provided, the editor updates to this floor level."
+                },
                 {
                   "name": "returns",
-                  "text": "Promise that resolves when the operation is complete"
+                  "text": "A promise that resolves when the refresh operation is complete."
                 }
               ],
-              "signature": "(floorLevel: string): Promise<void>",
+              "signature": "(floorLevel?: string): Promise<void>",
               "async": true
             },
+            {
+              "kind": "field",
+              "name": "reportingArea",
+              "description": "boolean: When true reporting area layer should be honored if it exists",
+              "type": {
+                "text": "boolean",
+                "values": [
+                  {
+                    "type": "boolean"
+                  }
+                ]
+              },
+              "default": "false",
+              "attribute": "reporting-area"
+            },
             {
               "kind": "field",
               "name": "reportingAreaLayer",
@@ -1589,8 +1612,8 @@
             },
             {
               "kind": "field",
-              "name": "reportOutsideAreaMessage",
-              "description": "string: User configurable message if feature is drawn outside polygon boundary",
+              "name": "reportingAreaMessage",
+              "description": "string: Message to be displayed when feature is outside the reportingAreaLayer",
               "type": {
                 "text": "string",
                 "values": [
@@ -1600,7 +1623,7 @@
                 ]
               },
               "default": "''",
-              "attribute": "report-outside-area-message"
+              "attribute": "reporting-area-message"
             },
             {
               "kind": "field",
@@ -1827,18 +1850,18 @@
               "fieldName": "isMobile"
             },
             {
-              "name": "report-outside-area-message",
-              "description": "string: User configurable message if feature is drawn outside polygon boundary",
+              "name": "reporting-area",
+              "description": "boolean: When true reporting area layer should be honored if it exists",
               "type": {
-                "text": "string",
+                "text": "boolean",
                 "values": [
                   {
-                    "type": "string"
+                    "type": "boolean"
                   }
                 ]
               },
-              "default": "''",
-              "fieldName": "reportOutsideAreaMessage"
+              "default": "false",
+              "fieldName": "reportingArea"
             },
             {
               "name": "reporting-area-layer",
@@ -1854,6 +1877,20 @@
               "default": "''",
               "fieldName": "reportingAreaLayer"
             },
+            {
+              "name": "reporting-area-message",
+              "description": "string: Message to be displayed when feature is outside the reportingAreaLayer",
+              "type": {
+                "text": "string",
+                "values": [
+                  {
+                    "type": "string"
+                  }
+                ]
+              },
+              "default": "''",
+              "fieldName": "reportingAreaMessage"
+            },
             {
               "name": "selected-layer-id",
               "description": "string: Layer id of the feature layer in which the new feature is to be created",
@@ -4061,21 +4098,6 @@
                 ]
               }
             },
-            {
-              "kind": "field",
-              "name": "reportOutsideAreaMessage",
-              "description": "string: User configurable message if feature is drawn outside polygon boundary",
-              "type": {
-                "text": "string",
-                "values": [
-                  {
-                    "type": "string"
-                  }
-                ]
-              },
-              "default": "''",
-              "attribute": "report-outside-area-message"
-            },
             {
               "kind": "field",
               "name": "reportsHeader",
@@ -4615,20 +4637,6 @@
               "default": "''",
               "fieldName": "reportButtonText"
             },
-            {
-              "name": "report-outside-area-message",
-              "description": "string: User configurable message if feature is drawn outside polygon boundary",
-              "type": {
-                "text": "string",
-                "values": [
-                  {
-                    "type": "string"
-                  }
-                ]
-              },
-              "default": "''",
-              "fieldName": "reportOutsideAreaMessage"
-            },
             {
               "name": "report-submitted-message",
               "description": "string: The message to display when the report has been submitted",
@@ -5076,7 +5084,7 @@
             {
               "kind": "field",
               "name": "showDeleteCount",
-              "description": "boolean: When true the delete count will be shown at button",
+              "description": "boolean: When true the delete button will show the number of features that will be deleted",
               "type": {
                 "text": "boolean",
                 "values": [
@@ -5152,7 +5160,7 @@
             },
             {
               "name": "show-delete-count",
-              "description": "boolean: When true the delete count will be shown at button",
+              "description": "boolean: When true the delete button will show the number of features that will be deleted",
               "type": {
                 "text": "boolean",
                 "values": [
@@ -5983,6 +5991,13 @@
                 "text": "void"
               }
             },
+            {
+              "name": "commentClick",
+              "description": "Emitted on demand when comment is clicked using the feature-list",
+              "type": {
+                "text": "void"
+              }
+            },
             {
               "name": "commentSelect",
               "description": "Emitted on demand when comment is selected using the feature-list",
@@ -6604,6 +6619,13 @@
             }
           ],
           "events": [
+            {
+              "name": "featureClick",
+              "description": "Emitted on demand when feature is clicked using the list",
+              "type": {
+                "text": "void"
+              }
+            },
             {
               "name": "featureSelect",
               "description": "Emitted on demand when feature is selected using the list",
@@ -11723,7 +11745,7 @@
             {
               "kind": "field",
               "name": "selectedWebMapId",
-              "description": ": selected web map",
+              "description": "string: The id of the map currently selected",
               "type": {
                 "text": "string",
                 "values": [
@@ -11874,7 +11896,7 @@
             },
             {
               "name": "selected-web-map-id",
-              "description": ": selected web map",
+              "description": "string: The id of the map currently selected",
               "type": {
                 "text": "string",
                 "values": [
@@ -13009,6 +13031,23 @@
               "default": "false",
               "attribute": "enable-basemap"
             },
+            {
+              "kind": "field",
+              "name": "enabledLayerIds",
+              "description": "string[]: Optional list of enabled layer ids\r\n If empty all layers will be available",
+              "type": {
+                "text": "Array<string>",
+                "references": [
+                  {
+                    "name": "Array",
+                    "package": "typescript",
+                    "module": "lib/lib.es5.d.ts",
+                    "start": 0,
+                    "end": 5
+                  }
+                ]
+              }
+            },
             {
               "kind": "field",
               "name": "enableFloorFilter",
@@ -16133,6 +16172,7 @@
             {
               "kind": "field",
               "name": "solutionItem",
+              "description": "The solution that will be deployed",
               "type": {
                 "text": "ITemplateInfo",
                 "references": [
@@ -16459,6 +16499,17 @@
           "pascalCaseName": "SolutionDeployingPanel",
           "importPath": "components/solution-deploying-panel",
           "members": [
+            {
+              "kind": "method",
+              "name": "close",
+              "description": "Closes the panel",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "signature": "(): void"
+            },
             {
               "kind": "method",
               "name": "componentOnReady",
@@ -16489,6 +16540,33 @@
                   "text": "const solutionDeployingPanel = document.createElement(\"solution-deploying-panel\");\ndocument.body.append(solutionDeployingPanel);\nsolutionDeployingPanel.componentOnReady().then(() => {\n  console.log(\"solution-deploying-panel is ready to go!\");\n});"
                 }
               ]
+            },
+            {
+              "kind": "method",
+              "name": "confirmCancel",
+              "description": "Confirm cancel the deployment",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "signature": "(): void"
+            },
+            {
+              "kind": "field",
+              "name": "solutionItem",
+              "description": "The solution that will be deployed",
+              "type": {
+                "text": "ITemplateInfo",
+                "references": [
+                  {
+                    "name": "ITemplateInfo",
+                    "module": "dist/utils/interfaces.d.ts",
+                    "start": 0,
+                    "end": 13
+                  }
+                ]
+              }
             }
           ]
         }
@@ -17152,6 +17230,23 @@
                   }
                 ]
               }
+            },
+            {
+              "kind": "field",
+              "name": "typeKeywords",
+              "description": "string[]: Collection of the solutions typeKeywords",
+              "type": {
+                "text": "Array<string>",
+                "references": [
+                  {
+                    "name": "Array",
+                    "package": "typescript",
+                    "module": "lib/lib.es5.d.ts",
+                    "start": 0,
+                    "end": 5
+                  }
+                ]
+              }
             }
           ],
           "attributes": [