@arcgis/portal-components 5.0.0-next.1 → 5.0.0-next.100

package/dist/docs/api.json

@@ -1,15 +1,16 @@
 {
-  "timestamp": "2025-09-26T04:37:34",
+  "timestamp": "2025-12-24T04:39:27",
   "compiler": {
     "name": "@arcgis/lumina-compiler",
-    "version": "5.0.0-next.1",
-    "typescriptVersion": "5.8.3"
+    "version": "5.0.0-next.100",
+    "typescriptVersion": "5.9.3"
   },
-  "schemaVersion": "1.0.0",
+  "schemaVersion": "2.1.0",
   "modules": [
     {
       "kind": "javascript-module",
-      "path": "src/components/portal-classification-banner/portal-classification-banner.tsx",
+      "path": "components/arcgis-portal-classification-banner",
+      "sourcePath": "src/components/portal-classification-banner/portal-classification-banner.tsx",
       "declarations": [
         {
           "kind": "class",
@@ -48,7 +49,6 @@
               },
               "description": "Create a promise that resolves once component is fully loaded.",
               "signature": "(): Promise<void>",
-              "async": true,
               "inheritedFrom": {
                 "name": "LitElement",
                 "package": "@arcgis/lumina"
@@ -78,8 +78,7 @@
                   ]
                 }
               },
-              "signature": "(): Promise<void>",
-              "async": true
+              "signature": "(): Promise<void>"
             },
             {
               "kind": "field",
@@ -106,7 +105,7 @@
                   {
                     "name": "PortalItem",
                     "package": "@arcgis/core",
-                    "module": "interfaces.d.ts",
+                    "module": "portal/PortalItem.d.ts",
                     "viewUrl": "https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html",
                     "start": 0,
                     "end": 10
@@ -206,15 +205,15 @@
           "kind": "custom-element-definition",
           "name": "arcgis-portal-classification-banner",
           "declaration": {
-            "name": "ArcgisPortalClassificationBanner",
-            "module": "src/components/portal-classification-banner/portal-classification-banner.tsx"
+            "name": "ArcgisPortalClassificationBanner"
           }
         }
       ]
     },
     {
       "kind": "javascript-module",
-      "path": "src/components/portal-classification-config/portal-classification-config.tsx",
+      "path": "components/arcgis-portal-classification-config",
+      "sourcePath": "src/components/portal-classification-config/portal-classification-config.tsx",
       "declarations": [
         {
           "kind": "class",
@@ -253,7 +252,6 @@
               },
               "description": "Create a promise that resolves once component is fully loaded.",
               "signature": "(): Promise<void>",
-              "async": true,
               "inheritedFrom": {
                 "name": "LitElement",
                 "package": "@arcgis/lumina"
@@ -283,8 +281,7 @@
                   ]
                 }
               },
-              "signature": "(): Promise<void>",
-              "async": true
+              "signature": "(): Promise<void>"
             },
             {
               "kind": "field",
@@ -296,7 +293,7 @@
                   {
                     "name": "PortalItem",
                     "package": "@arcgis/core",
-                    "module": "interfaces.d.ts",
+                    "module": "portal/PortalItem.d.ts",
                     "viewUrl": "https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html",
                     "start": 0,
                     "end": 10
@@ -335,8 +332,7 @@
                   ]
                 }
               },
-              "signature": "(): Promise<void>",
-              "async": true
+              "signature": "(): Promise<void>"
             },
             {
               "kind": "field",
@@ -402,8 +398,7 @@
                   ]
                 }
               },
-              "signature": "(): Promise<void>",
-              "async": true
+              "signature": "(): Promise<void>"
             },
             {
               "kind": "field",
@@ -482,15 +477,15 @@
           "kind": "custom-element-definition",
           "name": "arcgis-portal-classification-config",
           "declaration": {
-            "name": "ArcgisPortalClassificationConfig",
-            "module": "src/components/portal-classification-config/portal-classification-config.tsx"
+            "name": "ArcgisPortalClassificationConfig"
           }
         }
       ]
     },
     {
       "kind": "javascript-module",
-      "path": "src/components/portal-classification-favorite/portal-classification-favorite.tsx",
+      "path": "components/arcgis-portal-classification-favorite",
+      "sourcePath": "src/components/portal-classification-favorite/portal-classification-favorite.tsx",
       "declarations": [
         {
           "kind": "class",
@@ -538,7 +533,6 @@
               },
               "description": "Create a promise that resolves once component is fully loaded.",
               "signature": "(): Promise<void>",
-              "async": true,
               "inheritedFrom": {
                 "name": "LitElement",
                 "package": "@arcgis/lumina"
@@ -583,7 +577,7 @@
                   {
                     "name": "PortalItem",
                     "package": "@arcgis/core",
-                    "module": "interfaces.d.ts",
+                    "module": "portal/PortalItem.d.ts",
                     "viewUrl": "https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html",
                     "start": 0,
                     "end": 10
@@ -665,15 +659,15 @@
           "kind": "custom-element-definition",
           "name": "arcgis-portal-classification-favorite",
           "declaration": {
-            "name": "ArcgisPortalClassificationFavorite",
-            "module": "src/components/portal-classification-favorite/portal-classification-favorite.tsx"
+            "name": "ArcgisPortalClassificationFavorite"
           }
         }
       ]
     },
     {
       "kind": "javascript-module",
-      "path": "src/components/portal-classification-form-element/portal-classification-form-element.tsx",
+      "path": "components/arcgis-portal-classification-form-element",
+      "sourcePath": "src/components/portal-classification-form-element/portal-classification-form-element.tsx",
       "declarations": [
         {
           "kind": "class",
@@ -901,7 +895,6 @@
               },
               "description": "Create a promise that resolves once component is fully loaded.",
               "signature": "(): Promise<void>",
-              "async": true,
               "inheritedFrom": {
                 "name": "LitElement",
                 "package": "@arcgis/lumina"
@@ -913,6 +906,22 @@
                 }
               ]
             },
+            {
+              "kind": "field",
+              "name": "isRequiredErrors",
+              "type": {
+                "text": "Set<string>",
+                "references": [
+                  {
+                    "name": "Set",
+                    "package": "typescript",
+                    "module": "lib/lib.es2015.collection.d.ts",
+                    "start": 0,
+                    "end": 3
+                  }
+                ]
+              }
+            },
             {
               "kind": "field",
               "name": "renderingInfo",
@@ -958,15 +967,279 @@
           "kind": "custom-element-definition",
           "name": "arcgis-portal-classification-form-element",
           "declaration": {
-            "name": "ArcgisPortalClassificationFormElement",
-            "module": "src/components/portal-classification-form-element/portal-classification-form-element.tsx"
+            "name": "ArcgisPortalClassificationFormElement"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "components/arcgis-portal-extent-picker",
+      "sourcePath": "src/components/portal-extent-picker/portal-extent-picker.tsx",
+      "declarations": [
+        {
+          "kind": "class",
+          "customElement": true,
+          "name": "ArcgisPortalExtentPicker",
+          "tagName": "arcgis-portal-extent-picker",
+          "description": "To select extent value from a map or by entering coordinates.",
+          "superclass": {
+            "name": "LitElement",
+            "package": "@arcgis/lumina"
+          },
+          "pascalCaseName": "ArcgisPortalExtentPicker",
+          "importPath": "components/arcgis-portal-extent-picker",
+          "members": [
+            {
+              "kind": "field",
+              "name": "active",
+              "description": "if true, open the dialog",
+              "type": {
+                "text": "boolean",
+                "values": [
+                  {
+                    "type": "boolean"
+                  }
+                ]
+              },
+              "default": "false",
+              "attribute": "active"
+            },
+            {
+              "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>",
+              "inheritedFrom": {
+                "name": "LitElement",
+                "package": "@arcgis/lumina"
+              },
+              "docsTags": [
+                {
+                  "name": "example",
+                  "text": "```js\nconst arcgisPortalExtentPicker = document.querySelector(\"arcgis-portal-extent-picker\");\ndocument.body.append(arcgisPortalExtentPicker);\nawait arcgisPortalExtentPicker.componentOnReady();\nconsole.log(\"arcgis-portal-extent-picker is ready to go!\");\n```"
+                }
+              ]
+            },
+            {
+              "kind": "field",
+              "name": "contentOnly",
+              "description": "Optional; if true, show only the content without the calcite-dialog wrapper",
+              "type": {
+                "text": "boolean",
+                "values": [
+                  {
+                    "type": "boolean"
+                  }
+                ]
+              },
+              "default": "false",
+              "attribute": "content-only"
+            },
+            {
+              "kind": "field",
+              "name": "extentService",
+              "description": "Optional; URL of the extent service, used to initialize TileLayer",
+              "type": {
+                "text": "string",
+                "values": [
+                  {
+                    "type": "string"
+                  }
+                ]
+              },
+              "attribute": "extent-service"
+            },
+            {
+              "kind": "field",
+              "name": "extentValue",
+              "description": "current extent value",
+              "type": {
+                "text": "{\n    ymin: string;\n    ymax: string;\n    xmin: string;\n    xmax: string;\n}"
+              }
+            },
+            {
+              "kind": "method",
+              "name": "getExtent",
+              "description": "Returns the current extent value",
+              "return": {
+                "type": {
+                  "text": "{ extent: ExtentValue; }"
+                }
+              },
+              "signature": "(): ExtentObj"
+            },
+            {
+              "kind": "field",
+              "name": "isArea",
+              "description": "Optional; if true, display texts that are for areas rather than the default extent texts",
+              "type": {
+                "text": "boolean",
+                "values": [
+                  {
+                    "type": "boolean"
+                  }
+                ]
+              },
+              "default": "false",
+              "attribute": "is-area"
+            },
+            {
+              "kind": "field",
+              "name": "itemId",
+              "description": "Optional; if passed, use the itemId to load the Portal item",
+              "type": {
+                "text": "string",
+                "values": [
+                  {
+                    "type": "string"
+                  }
+                ]
+              },
+              "attribute": "item-id"
+            },
+            {
+              "kind": "field",
+              "name": "portal",
+              "description": "Optional; Portal instance",
+              "type": {
+                "text": "Portal",
+                "references": [
+                  {
+                    "name": "Portal",
+                    "package": "@arcgis/core",
+                    "module": "portal/Portal.d.ts",
+                    "viewUrl": "https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-Portal.html",
+                    "start": 0,
+                    "end": 6
+                  }
+                ]
+              }
+            }
+          ],
+          "attributes": [
+            {
+              "name": "active",
+              "description": "if true, open the dialog",
+              "type": {
+                "text": "boolean",
+                "values": [
+                  {
+                    "type": "boolean"
+                  }
+                ]
+              },
+              "default": "false",
+              "fieldName": "active"
+            },
+            {
+              "name": "content-only",
+              "description": "Optional; if true, show only the content without the calcite-dialog wrapper",
+              "type": {
+                "text": "boolean",
+                "values": [
+                  {
+                    "type": "boolean"
+                  }
+                ]
+              },
+              "default": "false",
+              "fieldName": "contentOnly"
+            },
+            {
+              "name": "extent-service",
+              "description": "Optional; URL of the extent service, used to initialize TileLayer",
+              "type": {
+                "text": "string",
+                "values": [
+                  {
+                    "type": "string"
+                  }
+                ]
+              },
+              "fieldName": "extentService"
+            },
+            {
+              "name": "is-area",
+              "description": "Optional; if true, display texts that are for areas rather than the default extent texts",
+              "type": {
+                "text": "boolean",
+                "values": [
+                  {
+                    "type": "boolean"
+                  }
+                ]
+              },
+              "default": "false",
+              "fieldName": "isArea"
+            },
+            {
+              "name": "item-id",
+              "description": "Optional; if passed, use the itemId to load the Portal item",
+              "type": {
+                "text": "string",
+                "values": [
+                  {
+                    "type": "string"
+                  }
+                ]
+              },
+              "fieldName": "itemId"
+            }
+          ],
+          "events": [
+            {
+              "name": "arcgisExtentPickerChange",
+              "description": "Emitted when the extent value changes",
+              "type": {
+                "text": "{ extent: ExtentValue; }"
+              }
+            },
+            {
+              "name": "arcgisExtentPickerClose",
+              "description": "Emitted when the dialog is closed",
+              "type": {
+                "text": "void"
+              }
+            },
+            {
+              "name": "arcgisExtentPickerSave",
+              "description": "Emitted when the save button is clicked",
+              "type": {
+                "text": "{ extent: ExtentValue; }"
+              }
+            }
+          ]
+        }
+      ],
+      "exports": [
+        {
+          "kind": "custom-element-definition",
+          "name": "arcgis-portal-extent-picker",
+          "declaration": {
+            "name": "ArcgisPortalExtentPicker"
           }
         }
       ]
     },
     {
       "kind": "javascript-module",
-      "path": "src/components/portal-field-delete/portal-field-delete.tsx",
+      "path": "components/arcgis-portal-field-delete",
+      "sourcePath": "src/components/portal-field-delete/portal-field-delete.tsx",
       "declarations": [
         {
           "kind": "class",
@@ -999,7 +1272,6 @@
               },
               "description": "Create a promise that resolves once component is fully loaded.",
               "signature": "(): Promise<void>",
-              "async": true,
               "inheritedFrom": {
                 "name": "LitElement",
                 "package": "@arcgis/lumina"
@@ -1054,7 +1326,7 @@
                   {
                     "name": "FeatureLayer",
                     "package": "@arcgis/core",
-                    "module": "interfaces.d.ts",
+                    "module": "layers/FeatureLayer.d.ts",
                     "viewUrl": "https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html",
                     "start": 0,
                     "end": 12
@@ -1062,7 +1334,7 @@
                   {
                     "name": "OrientedImageryLayer",
                     "package": "@arcgis/core",
-                    "module": "interfaces.d.ts",
+                    "module": "layers/OrientedImageryLayer.d.ts",
                     "viewUrl": "https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html",
                     "start": 15,
                     "end": 35
@@ -1088,7 +1360,7 @@
                   {
                     "name": "MapView",
                     "package": "@arcgis/core",
-                    "module": "interfaces.d.ts",
+                    "module": "views/MapView.d.ts",
                     "viewUrl": "https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html",
                     "start": 0,
                     "end": 7
@@ -1114,6 +1386,13 @@
             }
           ],
           "events": [
+            {
+              "name": "arcgisBeforeDelete",
+              "description": "Emitted when the user initiates the delete process.",
+              "type": {
+                "text": "void"
+              }
+            },
             {
               "name": "arcgisBeforeModalClose",
               "description": "Emitted before the modal is closed if the alert is handled in consumer.",
@@ -1148,8 +1427,7 @@
           "kind": "custom-element-definition",
           "name": "arcgis-portal-field-delete",
           "declaration": {
-            "name": "ArcgisPortalFieldDelete",
-            "module": "src/components/portal-field-delete/portal-field-delete.tsx"
+            "name": "ArcgisPortalFieldDelete"
           }
         }
       ]