@esri/solutions-components 1.0.0-next.20250521.1 → 1.0.0-next.20250527

package/dist/docs/api.json

@@ -1,5 +1,5 @@
 {
-  "timestamp": "2025-05-21T19:35:02",
+  "timestamp": "2025-05-27T20:50:20",
   "compiler": {
     "name": "@arcgis/lumina-compiler",
     "version": "4.33.0-next.137",
@@ -16048,6 +16048,17 @@
           "pascalCaseName": "SolutionDeployPanel",
           "importPath": "components/solution-deploy-panel",
           "members": [
+            {
+              "kind": "method",
+              "name": "close",
+              "description": "Closes the panel",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "signature": "(): void"
+            },
             {
               "kind": "method",
               "name": "componentOnReady",
@@ -16078,6 +16089,63 @@
                   "text": "const solutionDeployPanel = document.createElement(\"solution-deploy-panel\");\ndocument.body.append(solutionDeployPanel);\nsolutionDeployPanel.componentOnReady().then(() => {\n  console.log(\"solution-deploy-panel is ready to go!\");\n});"
                 }
               ]
+            },
+            {
+              "kind": "method",
+              "name": "deploy",
+              "description": "Deploys a solution",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "signature": "(): void"
+            },
+            {
+              "kind": "field",
+              "name": "solutionItem",
+              "type": {
+                "text": "ITemplateInfo",
+                "references": [
+                  {
+                    "name": "ITemplateInfo",
+                    "module": "dist/utils/interfaces.d.ts",
+                    "start": 0,
+                    "end": 13
+                  }
+                ]
+              }
+            },
+            {
+              "kind": "field",
+              "name": "wkid",
+              "description": "the wkid to match against.",
+              "type": {
+                "text": "string",
+                "values": [
+                  {
+                    "type": "string"
+                  }
+                ]
+              },
+              "default": "'3857'",
+              "attribute": "wkid"
+            }
+          ],
+          "attributes": [
+            {
+              "name": "wkid",
+              "description": "the wkid to match against.",
+              "type": {
+                "text": "string",
+                "values": [
+                  {
+                    "type": "string"
+                  }
+                ]
+              },
+              "default": "'3857'",
+              "fieldName": "wkid"
             }
           ]
         }
@@ -18613,10 +18681,14 @@
             {
               "kind": "field",
               "name": "sortType",
-              "description": "URL of organization, e.g., \"http://myOrg.maps.arcgis.com\"",
+              "description": "Define how the cards will be sorted",
               "type": {
-                "text": "\"new\" | \"numviews\" | \"relevance\" | \"suggested\" | \"title\" | \"updated\"",
+                "text": "\"created\" | \"new\" | \"numviews\" | \"relevance\" | \"suggested\" | \"title\" | \"updated\"",
                 "values": [
+                  {
+                    "value": "created",
+                    "type": "string"
+                  },
                   {
                     "value": "new",
                     "type": "string"
@@ -18753,10 +18825,14 @@
             },
             {
               "name": "sort-type",
-              "description": "URL of organization, e.g., \"http://myOrg.maps.arcgis.com\"",
+              "description": "Define how the cards will be sorted",
               "type": {
-                "text": "\"new\" | \"numviews\" | \"relevance\" | \"suggested\" | \"title\" | \"updated\"",
+                "text": "\"created\" | \"new\" | \"numviews\" | \"relevance\" | \"suggested\" | \"title\" | \"updated\"",
                 "values": [
+                  {
+                    "value": "created",
+                    "type": "string"
+                  },
                   {
                     "value": "new",
                     "type": "string"
@@ -18881,8 +18957,12 @@
               "name": "sortType",
               "description": "The current sort type applied to the displayed cards",
               "type": {
-                "text": "\"new\" | \"numviews\" | \"relevance\" | \"suggested\" | \"title\" | \"updated\"",
+                "text": "\"created\" | \"new\" | \"numviews\" | \"relevance\" | \"suggested\" | \"title\" | \"updated\"",
                 "values": [
+                  {
+                    "value": "created",
+                    "type": "string"
+                  },
                   {
                     "value": "new",
                     "type": "string"
@@ -18932,8 +19012,12 @@
               "name": "sort-type",
               "description": "The current sort type applied to the displayed cards",
               "type": {
-                "text": "\"new\" | \"numviews\" | \"relevance\" | \"suggested\" | \"title\" | \"updated\"",
+                "text": "\"created\" | \"new\" | \"numviews\" | \"relevance\" | \"suggested\" | \"title\" | \"updated\"",
                 "values": [
+                  {
+                    "value": "created",
+                    "type": "string"
+                  },
                   {
                     "value": "new",
                     "type": "string"
@@ -19202,10 +19286,57 @@
             "name": "LitElement",
             "package": "@arcgis/lumina"
           },
-          "encapsulation": "none",
           "pascalCaseName": "SolutionsDeployedPanel",
           "importPath": "components/solutions-deployed-panel",
           "members": [
+            {
+              "kind": "field",
+              "name": "agoSolutionsGroupId",
+              "description": "The group id that contains agol solutions.",
+              "type": {
+                "text": "string",
+                "values": [
+                  {
+                    "type": "string"
+                  }
+                ]
+              },
+              "default": "\"\"",
+              "attribute": "ago-solutions-group-id"
+            },
+            {
+              "kind": "field",
+              "name": "authContextConsumer",
+              "description": "The authentication from global nav",
+              "type": {
+                "text": "ContextConsumer<{\n    __context__: Auth;\n}, HTMLElement & ReactiveControllerHost>",
+                "references": [
+                  {
+                    "name": "ContextConsumer",
+                    "package": "@lit/context",
+                    "module": "development/lib/controllers/context-consumer.d.ts",
+                    "start": 0,
+                    "end": 15
+                  },
+                  {
+                    "name": "HTMLElement",
+                    "package": "typescript",
+                    "module": "lib/lib.dom.d.ts",
+                    "viewUrl": "https://developer.mozilla.org/docs/Web/API/HTMLElement",
+                    "start": 44,
+                    "end": 55
+                  },
+                  {
+                    "name": "ReactiveControllerHost",
+                    "package": "@lit/reactive-element",
+                    "module": "development/reactive-controller.d.ts",
+                    "start": 58,
+                    "end": 80
+                  }
+                ]
+              },
+              "readonly": true
+            },
             {
               "kind": "method",
               "name": "componentOnReady",
@@ -19236,68 +19367,531 @@
                   "text": "const solutionsDeployedPanel = document.createElement(\"solutions-deployed-panel\");\ndocument.body.append(solutionsDeployedPanel);\nsolutionsDeployedPanel.componentOnReady().then(() => {\n  console.log(\"solutions-deployed-panel is ready to go!\");\n});"
                 }
               ]
-            }
-          ]
-        }
-      ],
-      "exports": [
-        {
-          "kind": "custom-element-definition",
-          "name": "solutions-deployed-panel",
-          "declaration": {
-            "name": "SolutionsDeployedPanel",
-            "module": "src/components/solutions-deployed-panel/solutions-deployed-panel.tsx"
-          }
-        }
-      ]
-    },
-    {
-      "kind": "javascript-module",
-      "path": "src/components/solutions-deployed-shell/solutions-deployed-shell.tsx",
-      "declarations": [
-        {
-          "kind": "class",
-          "customElement": true,
-          "name": "SolutionsDeployedShell",
-          "tagName": "solutions-deployed-shell",
-          "superclass": {
-            "name": "LitElement",
-            "package": "@arcgis/lumina"
-          },
-          "encapsulation": "none",
-          "pascalCaseName": "SolutionsDeployedShell",
-          "importPath": "components/solutions-deployed-shell",
-          "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
-                    }
-                  ]
-                }
+              "kind": "field",
+              "name": "enterpriseSolutionsGroupId",
+              "description": "The group id that contains enterprise solutions.",
+              "type": {
+                "text": "string",
+                "values": [
+                  {
+                    "type": "string"
+                  }
+                ]
               },
-              "description": "Create a promise that resolves once component is fully loaded.",
-              "signature": "(): Promise<void>",
-              "async": true,
-              "inheritedFrom": {
-                "name": "LitElement",
-                "package": "@arcgis/lumina"
+              "default": "\"\"",
+              "attribute": "enterprise-solutions-group-id"
+            },
+            {
+              "kind": "field",
+              "name": "locale",
+              "description": "The current locale.",
+              "type": {
+                "text": "string",
+                "values": [
+                  {
+                    "type": "string"
+                  }
+                ]
               },
-              "docsTags": [
+              "default": "\"\"",
+              "attribute": "locale"
+            },
+            {
+              "kind": "field",
+              "name": "orgUrl",
+              "description": "URL of organization, e.g., \"http://myOrg.maps.arcgis.com\"",
+              "type": {
+                "text": "string",
+                "values": [
+                  {
+                    "type": "string"
+                  }
+                ]
+              },
+              "default": "\"\"",
+              "attribute": "org-url"
+            },
+            {
+              "kind": "field",
+              "name": "portalUrl",
+              "description": "URL of portal, e.g., \"https://www.arcgis.com\"",
+              "type": {
+                "text": "string",
+                "values": [
+                  {
+                    "type": "string"
+                  }
+                ]
+              },
+              "default": "\"\"",
+              "attribute": "portal-url"
+            },
+            {
+              "kind": "method",
+              "name": "searchSolutions",
+              "description": "Search solutions based on key criteria",
+              "parameters": [
                 {
-                  "name": "example",
-                  "text": "const solutionsDeployedShell = document.createElement(\"solutions-deployed-shell\");\ndocument.body.append(solutionsDeployedShell);\nsolutionsDeployedShell.componentOnReady().then(() => {\n  console.log(\"solutions-deployed-shell is ready to go!\");\n});"
-                }
-              ]
+                  "name": "searchOptions",
+                  "optional": true,
+                  "type": {
+                    "text": "IFilterOption | ISearchOption | ISortOption | undefined",
+                    "references": [
+                      {
+                        "name": "IFilterOption",
+                        "module": "dist/utils/interfaces.d.ts",
+                        "start": 0,
+                        "end": 13
+                      },
+                      {
+                        "name": "ISearchOption",
+                        "module": "dist/utils/interfaces.d.ts",
+                        "start": 16,
+                        "end": 29
+                      },
+                      {
+                        "name": "ISortOption",
+                        "module": "dist/utils/interfaces.d.ts",
+                        "start": 32,
+                        "end": 43
+                      }
+                    ],
+                    "values": [
+                      {
+                        "type": "IFilterOption"
+                      },
+                      {
+                        "type": "ISearchOption"
+                      },
+                      {
+                        "type": "ISortOption"
+                      },
+                      {
+                        "type": "undefined"
+                      }
+                    ]
+                  }
+                }
+              ],
+              "return": {
+                "type": {
+                  "text": "Promise<void>",
+                  "references": [
+                    {
+                      "name": "Promise",
+                      "package": "typescript",
+                      "module": "lib/lib.es5.d.ts",
+                      "start": 0,
+                      "end": 7
+                    }
+                  ]
+                }
+              },
+              "docsTags": [
+                {
+                  "name": "param",
+                  "text": "searchOptions the key criteria to search with"
+                }
+              ],
+              "signature": "(searchOptions?: IFilterOption | ISearchOption | ISortOption): Promise<void>",
+              "async": true
+            },
+            {
+              "kind": "field",
+              "name": "sortType",
+              "description": "Define how the cards will be sorted\r\nvalid options for deplyed cards are: created (ie date deployed), relevance, title",
+              "type": {
+                "text": "\"created\" | \"new\" | \"numviews\" | \"relevance\" | \"suggested\" | \"title\" | \"updated\"",
+                "values": [
+                  {
+                    "value": "created",
+                    "type": "string"
+                  },
+                  {
+                    "value": "new",
+                    "type": "string"
+                  },
+                  {
+                    "value": "numviews",
+                    "type": "string"
+                  },
+                  {
+                    "value": "relevance",
+                    "type": "string"
+                  },
+                  {
+                    "value": "suggested",
+                    "type": "string"
+                  },
+                  {
+                    "value": "title",
+                    "type": "string"
+                  },
+                  {
+                    "value": "updated",
+                    "type": "string"
+                  }
+                ]
+              },
+              "default": "'created'",
+              "attribute": "sort-type"
+            },
+            {
+              "kind": "field",
+              "name": "userSessionContextConsumer",
+              "description": "The user session to use for fetching solutions",
+              "type": {
+                "text": "ContextConsumer<{\n    __context__: ArcGISIdentityManager;\n}, HTMLElement & ReactiveControllerHost>",
+                "references": [
+                  {
+                    "name": "ContextConsumer",
+                    "package": "@lit/context",
+                    "module": "development/lib/controllers/context-consumer.d.ts",
+                    "start": 0,
+                    "end": 15
+                  },
+                  {
+                    "name": "HTMLElement",
+                    "package": "typescript",
+                    "module": "lib/lib.dom.d.ts",
+                    "viewUrl": "https://developer.mozilla.org/docs/Web/API/HTMLElement",
+                    "start": 61,
+                    "end": 72
+                  },
+                  {
+                    "name": "ReactiveControllerHost",
+                    "package": "@lit/reactive-element",
+                    "module": "development/reactive-controller.d.ts",
+                    "start": 75,
+                    "end": 97
+                  }
+                ]
+              },
+              "readonly": true
+            }
+          ],
+          "attributes": [
+            {
+              "name": "ago-solutions-group-id",
+              "description": "The group id that contains agol solutions.",
+              "type": {
+                "text": "string",
+                "values": [
+                  {
+                    "type": "string"
+                  }
+                ]
+              },
+              "default": "\"\"",
+              "fieldName": "agoSolutionsGroupId"
+            },
+            {
+              "name": "enterprise-solutions-group-id",
+              "description": "The group id that contains enterprise solutions.",
+              "type": {
+                "text": "string",
+                "values": [
+                  {
+                    "type": "string"
+                  }
+                ]
+              },
+              "default": "\"\"",
+              "fieldName": "enterpriseSolutionsGroupId"
+            },
+            {
+              "name": "locale",
+              "description": "The current locale.",
+              "type": {
+                "text": "string",
+                "values": [
+                  {
+                    "type": "string"
+                  }
+                ]
+              },
+              "default": "\"\"",
+              "fieldName": "locale"
+            },
+            {
+              "name": "org-url",
+              "description": "URL of organization, e.g., \"http://myOrg.maps.arcgis.com\"",
+              "type": {
+                "text": "string",
+                "values": [
+                  {
+                    "type": "string"
+                  }
+                ]
+              },
+              "default": "\"\"",
+              "fieldName": "orgUrl"
+            },
+            {
+              "name": "portal-url",
+              "description": "URL of portal, e.g., \"https://www.arcgis.com\"",
+              "type": {
+                "text": "string",
+                "values": [
+                  {
+                    "type": "string"
+                  }
+                ]
+              },
+              "default": "\"\"",
+              "fieldName": "portalUrl"
+            },
+            {
+              "name": "sort-type",
+              "description": "Define how the cards will be sorted\r\nvalid options for deplyed cards are: created (ie date deployed), relevance, title",
+              "type": {
+                "text": "\"created\" | \"new\" | \"numviews\" | \"relevance\" | \"suggested\" | \"title\" | \"updated\"",
+                "values": [
+                  {
+                    "value": "created",
+                    "type": "string"
+                  },
+                  {
+                    "value": "new",
+                    "type": "string"
+                  },
+                  {
+                    "value": "numviews",
+                    "type": "string"
+                  },
+                  {
+                    "value": "relevance",
+                    "type": "string"
+                  },
+                  {
+                    "value": "suggested",
+                    "type": "string"
+                  },
+                  {
+                    "value": "title",
+                    "type": "string"
+                  },
+                  {
+                    "value": "updated",
+                    "type": "string"
+                  }
+                ]
+              },
+              "default": "'created'",
+              "fieldName": "sortType"
+            }
+          ],
+          "events": [
+            {
+              "name": "deployedCardsFetched",
+              "description": "Emitted on demand when cards are fetched",
+              "type": {
+                "text": "number",
+                "values": [
+                  {
+                    "type": "number"
+                  }
+                ]
+              }
+            }
+          ]
+        }
+      ],
+      "exports": [
+        {
+          "kind": "custom-element-definition",
+          "name": "solutions-deployed-panel",
+          "declaration": {
+            "name": "SolutionsDeployedPanel",
+            "module": "src/components/solutions-deployed-panel/solutions-deployed-panel.tsx"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/components/solutions-deployed-shell/solutions-deployed-shell.tsx",
+      "declarations": [
+        {
+          "kind": "class",
+          "customElement": true,
+          "name": "SolutionsDeployedShell",
+          "tagName": "solutions-deployed-shell",
+          "superclass": {
+            "name": "LitElement",
+            "package": "@arcgis/lumina"
+          },
+          "pascalCaseName": "SolutionsDeployedShell",
+          "importPath": "components/solutions-deployed-shell",
+          "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": "const solutionsDeployedShell = document.createElement(\"solutions-deployed-shell\");\ndocument.body.append(solutionsDeployedShell);\nsolutionsDeployedShell.componentOnReady().then(() => {\n  console.log(\"solutions-deployed-shell is ready to go!\");\n});"
+                }
+              ]
+            },
+            {
+              "kind": "field",
+              "name": "solutionsCount",
+              "description": "The number of solution cards currently displayed",
+              "type": {
+                "text": "number",
+                "values": [
+                  {
+                    "type": "number"
+                  }
+                ]
+              },
+              "default": "0",
+              "attribute": "solutions-count"
+            },
+            {
+              "kind": "field",
+              "name": "sortType",
+              "description": "The current sort type applied to the displayed cards",
+              "type": {
+                "text": "\"created\" | \"new\" | \"numviews\" | \"relevance\" | \"suggested\" | \"title\" | \"updated\"",
+                "values": [
+                  {
+                    "value": "created",
+                    "type": "string"
+                  },
+                  {
+                    "value": "new",
+                    "type": "string"
+                  },
+                  {
+                    "value": "numviews",
+                    "type": "string"
+                  },
+                  {
+                    "value": "relevance",
+                    "type": "string"
+                  },
+                  {
+                    "value": "suggested",
+                    "type": "string"
+                  },
+                  {
+                    "value": "title",
+                    "type": "string"
+                  },
+                  {
+                    "value": "updated",
+                    "type": "string"
+                  }
+                ]
+              },
+              "default": "'created'",
+              "attribute": "sort-type"
+            }
+          ],
+          "attributes": [
+            {
+              "name": "solutions-count",
+              "description": "The number of solution cards currently displayed",
+              "type": {
+                "text": "number",
+                "values": [
+                  {
+                    "type": "number"
+                  }
+                ]
+              },
+              "default": "0",
+              "fieldName": "solutionsCount"
+            },
+            {
+              "name": "sort-type",
+              "description": "The current sort type applied to the displayed cards",
+              "type": {
+                "text": "\"created\" | \"new\" | \"numviews\" | \"relevance\" | \"suggested\" | \"title\" | \"updated\"",
+                "values": [
+                  {
+                    "value": "created",
+                    "type": "string"
+                  },
+                  {
+                    "value": "new",
+                    "type": "string"
+                  },
+                  {
+                    "value": "numviews",
+                    "type": "string"
+                  },
+                  {
+                    "value": "relevance",
+                    "type": "string"
+                  },
+                  {
+                    "value": "suggested",
+                    "type": "string"
+                  },
+                  {
+                    "value": "title",
+                    "type": "string"
+                  },
+                  {
+                    "value": "updated",
+                    "type": "string"
+                  }
+                ]
+              },
+              "default": "'created'",
+              "fieldName": "sortType"
+            }
+          ],
+          "events": [
+            {
+              "name": "filterRemoved",
+              "description": "Emitted on demand when a filter chip is closed",
+              "type": {
+                "text": "string",
+                "values": [
+                  {
+                    "type": "string"
+                  }
+                ]
+              }
+            },
+            {
+              "name": "tokenRefreshed",
+              "description": "Emitted on demand when the auth token is updated",
+              "type": {
+                "text": "string",
+                "values": [
+                  {
+                    "type": "string"
+                  }
+                ]
+              }
             }
           ]
         }