@esri/solutions-components 1.1.4 → 1.1.5

package/dist/docs/api.json

@@ -1,5 +1,5 @@
 {
-  "timestamp": "2025-10-23T21:19:58",
+  "timestamp": "2025-10-30T15:46:52",
   "compiler": {
     "name": "@arcgis/lumina-compiler",
     "version": "4.34.0",
@@ -23,9 +23,41 @@
           "pascalCaseName": "ArcgisSolutionsAssistant",
           "importPath": "components/arcgis-solutions-assistant",
           "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 arcgisSolutionsAssistant = document.querySelector(\"arcgis-solutions-assistant\");\ndocument.body.append(arcgisSolutionsAssistant);\nawait arcgisSolutionsAssistant.componentOnReady();\nconsole.log(\"arcgis-solutions-assistant is ready to go!\");\n```"
+                }
+              ]
+            },
             {
               "kind": "field",
-              "name": "AIServerUrl",
+              "name": "docAIurl",
+              "description": "Define the Doc Assistant chat endpoint",
               "type": {
                 "text": "string",
                 "values": [
@@ -34,43 +66,218 @@
                   }
                 ]
               },
-              "default": "\"http://localhost:8080/skills/solution_deployment/chat\"",
-              "attribute": "ai-server-url"
+              "attribute": "doc-a-iurl"
             },
             {
               "kind": "method",
-              "name": "componentOnReady",
+              "name": "handleSendMessage",
+              "description": "Submits a query to the AI Assitant based on what is in the input textarea.\r\nIf there is an exisitng conversation, the conversation id is also sent along.",
               "return": {
                 "type": {
                   "text": "Promise<void>",
                   "references": [
                     {
-                      "module": "lib/lib.es5.d.ts",
                       "name": "Promise",
                       "package": "typescript",
+                      "module": "lib/lib.es5.d.ts",
                       "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"
+              "async": true
+            },
+            {
+              "kind": "method",
+              "name": "loopRequest",
+              "description": "Calls the AI (polling) until there is no additional requests.\r\nAlong the way id there is a message or context, process and show.\r\nIf it is solution question, start off a new request to Doc Assistant.",
+              "parameters": [
+                {
+                  "name": "parameter",
+                  "type": {
+                    "text": "{\n    conversationId: string;\n    inquiryId: string;\n    sequenceNumber: number;\n    message?: string | null | undefined;\n    context?: ConversationContext | undefined;\n    hasMore: boolean;\n}"
+                  }
+                },
+                {
+                  "name": "token",
+                  "type": {
+                    "text": "string",
+                    "values": [
+                      {
+                        "type": "string"
+                      }
+                    ]
+                  }
+                },
+                {
+                  "name": "requestURL",
+                  "type": {
+                    "text": "string",
+                    "values": [
+                      {
+                        "type": "string"
+                      }
+                    ]
+                  }
+                }
+              ],
+              "return": {
+                "type": {
+                  "text": "Promise<void>",
+                  "references": [
+                    {
+                      "name": "Promise",
+                      "package": "typescript",
+                      "module": "lib/lib.es5.d.ts",
+                      "start": 0,
+                      "end": 7
+                    }
+                  ]
+                }
               },
               "docsTags": [
                 {
-                  "name": "example",
-                  "text": "```js\nconst arcgisSolutionsAssistant = document.querySelector(\"arcgis-solutions-assistant\");\ndocument.body.append(arcgisSolutionsAssistant);\nawait arcgisSolutionsAssistant.componentOnReady();\nconsole.log(\"arcgis-solutions-assistant is ready to go!\");\n```"
+                  "name": "param",
+                  "text": "parameter stores the conversation and inquiry id"
+                },
+                {
+                  "name": "param",
+                  "text": "token the authenticated user session"
+                },
+                {
+                  "name": "param",
+                  "text": "requestURL AI server to request"
                 }
-              ]
+              ],
+              "signature": "(parameter: ConversationResponse, token: string, requestURL: string): Promise<void>",
+              "async": true
+            },
+            {
+              "kind": "field",
+              "name": "open",
+              "description": "Flag to open or close panel",
+              "type": {
+                "text": "boolean",
+                "values": [
+                  {
+                    "type": "boolean"
+                  }
+                ]
+              },
+              "default": "false",
+              "attribute": "open"
+            },
+            {
+              "kind": "method",
+              "name": "requestAIServer",
+              "description": "Request sent to the AI server via fetch.\r\nALong the way id there is a message or context, process and show.",
+              "parameters": [
+                {
+                  "name": "requestInfo",
+                  "type": {
+                    "text": "unknown"
+                  }
+                },
+                {
+                  "name": "token",
+                  "type": {
+                    "text": "string",
+                    "values": [
+                      {
+                        "type": "string"
+                      }
+                    ]
+                  }
+                },
+                {
+                  "name": "requestURL",
+                  "type": {
+                    "text": "string",
+                    "values": [
+                      {
+                        "type": "string"
+                      }
+                    ]
+                  }
+                }
+              ],
+              "return": {
+                "type": {
+                  "text": "Promise<{\n    conversationId: string;\n    inquiryId: string;\n    sequenceNumber: number;\n    message?: string | null | undefined;\n    context?: ConversationContext | undefined;\n    hasMore: boolean;\n}>",
+                  "references": [
+                    {
+                      "name": "Promise",
+                      "package": "typescript",
+                      "module": "lib/lib.es5.d.ts",
+                      "start": 0,
+                      "end": 7
+                    }
+                  ]
+                }
+              },
+              "docsTags": [
+                {
+                  "name": "param",
+                  "text": "requestInfo the request object to send to the server"
+                },
+                {
+                  "name": "param",
+                  "text": "token the authenticated user session"
+                },
+                {
+                  "name": "param",
+                  "text": "requestURL AI server to request"
+                }
+              ],
+              "signature": "(requestInfo: unknown, token: string, requestURL: string): Promise<ConversationResponse>",
+              "async": true
+            },
+            {
+              "kind": "method",
+              "name": "resetChat",
+              "description": "Resets the message history and clears the chat window.",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "signature": "(): void"
+            },
+            {
+              "kind": "field",
+              "name": "serverRoot",
+              "description": "Define the AI server to access",
+              "type": {
+                "text": "string",
+                "values": [
+                  {
+                    "type": "string"
+                  }
+                ]
+              },
+              "default": "'https://aiservices-beta.arcgis.com/'",
+              "attribute": "server-root"
+            },
+            {
+              "kind": "field",
+              "name": "solutionAIurl",
+              "description": "Define the Solutions chat endpoint",
+              "type": {
+                "text": "string",
+                "values": [
+                  {
+                    "type": "string"
+                  }
+                ]
+              },
+              "attribute": "solution-a-iurl"
             },
             {
               "kind": "field",
               "name": "token",
+              "description": "Define the authentication for requests",
               "type": {
                 "text": "string",
                 "values": [
@@ -84,7 +291,49 @@
           ],
           "attributes": [
             {
-              "name": "ai-server-url",
+              "name": "doc-a-iurl",
+              "description": "Define the Doc Assistant chat endpoint",
+              "type": {
+                "text": "string",
+                "values": [
+                  {
+                    "type": "string"
+                  }
+                ]
+              },
+              "fieldName": "docAIurl"
+            },
+            {
+              "name": "open",
+              "description": "Flag to open or close panel",
+              "type": {
+                "text": "boolean",
+                "values": [
+                  {
+                    "type": "boolean"
+                  }
+                ]
+              },
+              "default": "false",
+              "fieldName": "open"
+            },
+            {
+              "name": "server-root",
+              "description": "Define the AI server to access",
+              "type": {
+                "text": "string",
+                "values": [
+                  {
+                    "type": "string"
+                  }
+                ]
+              },
+              "default": "'https://aiservices-beta.arcgis.com/'",
+              "fieldName": "serverRoot"
+            },
+            {
+              "name": "solution-a-iurl",
+              "description": "Define the Solutions chat endpoint",
               "type": {
                 "text": "string",
                 "values": [
@@ -93,11 +342,11 @@
                   }
                 ]
               },
-              "default": "\"http://localhost:8080/skills/solution_deployment/chat\"",
-              "fieldName": "AIServerUrl"
+              "fieldName": "solutionAIurl"
             },
             {
               "name": "token",
+              "description": "Define the authentication for requests",
               "type": {
                 "text": "string",
                 "values": [
@@ -111,9 +360,15 @@
           ],
           "events": [
             {
-              "name": "arcgisCreateSolutionEvent",
+              "name": "closeAssistant",
+              "description": "Emitted on demand when cards are fetched",
               "type": {
-                "text": "void"
+                "text": "boolean",
+                "values": [
+                  {
+                    "type": "boolean"
+                  }
+                ]
               }
             }
           ]
@@ -18349,6 +18604,27 @@
               "default": "'none'",
               "attribute": "list-selection-mode"
             },
+            {
+              "kind": "method",
+              "name": "selectFirstItem",
+              "description": "Selects the first item in the accordion and expands the accordion item containing it.",
+              "return": {
+                "type": {
+                  "text": "Promise<void>",
+                  "references": [
+                    {
+                      "name": "Promise",
+                      "package": "typescript",
+                      "module": "lib/lib.es5.d.ts",
+                      "start": 0,
+                      "end": 7
+                    }
+                  ]
+                }
+              },
+              "signature": "(): Promise<void>",
+              "async": true
+            },
             {
               "kind": "method",
               "name": "selectItem",
@@ -21488,6 +21764,21 @@
                 ]
               }
             },
+            {
+              "name": "detailsCardSelected",
+              "description": "Emitted on demand when the details card is selected.",
+              "type": {
+                "text": "ISolutionInfoCard",
+                "references": [
+                  {
+                    "name": "ISolutionInfoCard",
+                    "module": "dist/utils/interfaces.d.ts",
+                    "start": 0,
+                    "end": 17
+                  }
+                ]
+              }
+            },
             {
               "name": "searchTermSet",
               "description": "Emitted on demand when the serachTerm is set from url param",
@@ -21929,18 +22220,18 @@
               "name": "deployAppTabSelected",
               "description": "Tab selected event",
               "type": {
-                "text": "\"all-solutions\" | \"details\" | \"my-deployments\" | \"resources\"",
+                "text": "\"all-solutions\" | \"deployments\" | \"details\" | \"resources\"",
                 "values": [
                   {
                     "value": "all-solutions",
                     "type": "string"
                   },
                   {
-                    "value": "details",
+                    "value": "deployments",
                     "type": "string"
                   },
                   {
-                    "value": "my-deployments",
+                    "value": "details",
                     "type": "string"
                   },
                   {
@@ -22003,18 +22294,18 @@
                 {
                   "name": "tab",
                   "type": {
-                    "text": "\"all-solutions\" | \"details\" | \"my-deployments\" | \"resources\"",
+                    "text": "\"all-solutions\" | \"deployments\" | \"details\" | \"resources\"",
                     "values": [
                       {
                         "value": "all-solutions",
                         "type": "string"
                       },
                       {
-                        "value": "details",
+                        "value": "deployments",
                         "type": "string"
                       },
                       {
-                        "value": "my-deployments",
+                        "value": "details",
                         "type": "string"
                       },
                       {
@@ -22153,18 +22444,18 @@
               "name": "navTabSelected",
               "description": "Tab selected event",
               "type": {
-                "text": "\"all-solutions\" | \"details\" | \"my-deployments\" | \"resources\"",
+                "text": "\"all-solutions\" | \"deployments\" | \"details\" | \"resources\"",
                 "values": [
                   {
                     "value": "all-solutions",
                     "type": "string"
                   },
                   {
-                    "value": "details",
+                    "value": "deployments",
                     "type": "string"
                   },
                   {
-                    "value": "my-deployments",
+                    "value": "details",
                     "type": "string"
                   },
                   {
@@ -23227,6 +23518,21 @@
               "default": "false",
               "attribute": "hide-industry-filter"
             },
+            {
+              "kind": "field",
+              "name": "isAIDialogOpen",
+              "description": "Determines if AI Assistant is open.",
+              "type": {
+                "text": "boolean",
+                "values": [
+                  {
+                    "type": "boolean"
+                  }
+                ]
+              },
+              "default": "false",
+              "attribute": "is-ai-dialog-open"
+            },
             {
               "kind": "field",
               "name": "isAIsettingEnabled",
@@ -23287,6 +23593,20 @@
               "default": "false",
               "fieldName": "isAIsettingEnabled"
             },
+            {
+              "name": "is-ai-dialog-open",
+              "description": "Determines if AI Assistant is open.",
+              "type": {
+                "text": "boolean",
+                "values": [
+                  {
+                    "type": "boolean"
+                  }
+                ]
+              },
+              "default": "false",
+              "fieldName": "isAIDialogOpen"
+            },
             {
               "name": "show-reset",
               "description": "Flag to display reset in the panel",
@@ -23848,14 +24168,14 @@
               "name": "scope",
               "description": "The enviornment on which to perform search or sort",
               "type": {
-                "text": "\"all-solutions\" | \"my-deployments\"",
+                "text": "\"all-solutions\" | \"deployments\"",
                 "values": [
                   {
                     "value": "all-solutions",
                     "type": "string"
                   },
                   {
-                    "value": "my-deployments",
+                    "value": "deployments",
                     "type": "string"
                   }
                 ]
@@ -23931,14 +24251,14 @@
               "name": "scope",
               "description": "The enviornment on which to perform search or sort",
               "type": {
-                "text": "\"all-solutions\" | \"my-deployments\"",
+                "text": "\"all-solutions\" | \"deployments\"",
                 "values": [
                   {
                     "value": "all-solutions",
                     "type": "string"
                   },
                   {
-                    "value": "my-deployments",
+                    "value": "deployments",
                     "type": "string"
                   }
                 ]