@esri/hub-web-components 0.0.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (70) hide show
  1. package/LICENSE.md +13 -0
  2. package/README.md +35 -0
  3. package/dist/cdn/2NFBUAOJ.js +4 -0
  4. package/dist/cdn/3ZRJV7VD.js +3 -0
  5. package/dist/cdn/CADUTR4A.js +4 -0
  6. package/dist/cdn/E5QHKHGG.js +41 -0
  7. package/dist/cdn/IDWXUFCL.js +6 -0
  8. package/dist/cdn/MNXAWZSB.js +9 -0
  9. package/dist/cdn/YBCM3RPB.js +4 -0
  10. package/dist/cdn/assets/hub-ai-assistant/t9n/messages.en.json +1 -0
  11. package/dist/cdn/assets/hub-ai-assistant/t9n/messages.es.json +1 -0
  12. package/dist/cdn/index.js +4 -0
  13. package/dist/chunks/chat-action.js +41 -0
  14. package/dist/chunks/runtime.js +12 -0
  15. package/dist/components/arcgis-chat-shell/customElement.d.ts +27 -0
  16. package/dist/components/arcgis-chat-shell/customElement.js +44 -0
  17. package/dist/components/arcgis-chat-shell/index.d.ts +5 -0
  18. package/dist/components/arcgis-chat-shell/index.js +5 -0
  19. package/dist/components/arcgis-chat-ui/components/chat-action/customElement.d.ts +9 -0
  20. package/dist/components/arcgis-chat-ui/components/chat-action/customElement.js +9 -0
  21. package/dist/components/arcgis-chat-ui/components/chat-action/index.d.ts +2 -0
  22. package/dist/components/arcgis-chat-ui/components/chat-action/index.js +2 -0
  23. package/dist/components/arcgis-chat-ui/components/chat-response/customElement.d.ts +9 -0
  24. package/dist/components/arcgis-chat-ui/components/chat-response/customElement.js +42 -0
  25. package/dist/components/arcgis-chat-ui/components/chat-response/index.d.ts +8 -0
  26. package/dist/components/arcgis-chat-ui/components/chat-response/index.js +8 -0
  27. package/dist/components/arcgis-chat-ui/components/chat-status/customElement.d.ts +6 -0
  28. package/dist/components/arcgis-chat-ui/components/chat-status/customElement.js +8 -0
  29. package/dist/components/arcgis-chat-ui/components/chat-status/index.d.ts +1 -0
  30. package/dist/components/arcgis-chat-ui/components/chat-status/index.js +1 -0
  31. package/dist/components/arcgis-chat-ui/customElement.d.ts +58 -0
  32. package/dist/components/arcgis-chat-ui/customElement.js +127 -0
  33. package/dist/components/arcgis-chat-ui/index.d.ts +3 -0
  34. package/dist/components/arcgis-chat-ui/index.js +3 -0
  35. package/dist/components/arcgis-chat-ui/util/constants.d.ts +4 -0
  36. package/dist/components/arcgis-chat-ui/util/customElement.d.ts +3 -0
  37. package/dist/components/arcgis-chat-ui/util/types.d.ts +27 -0
  38. package/dist/components/arcgis-hub-ai-assistant/customElement.d.ts +90 -0
  39. package/dist/components/arcgis-hub-ai-assistant/customElement.js +210 -0
  40. package/dist/components/arcgis-hub-ai-assistant/index.d.ts +9 -0
  41. package/dist/components/arcgis-hub-ai-assistant/index.js +9 -0
  42. package/dist/components/arcgis-hub-ai-assistant/util/api.d.ts +25 -0
  43. package/dist/components/arcgis-hub-ai-assistant/util/customElement.d.ts +18 -0
  44. package/dist/components/arcgis-hub-ai-assistant/util/customElement.js +33 -0
  45. package/dist/components/arcgis-hub-ai-assistant/util/framework.d.ts +184 -0
  46. package/dist/components/arcgis-hub-ai-assistant/util/index.d.ts +1 -0
  47. package/dist/components/arcgis-hub-ai-assistant/util/index.js +1 -0
  48. package/dist/components/arcgis-hub-ai-assistant/util/test.d.ts +1387 -0
  49. package/dist/controllers/useT9n.d.ts +1 -0
  50. package/dist/docs/api.json +1113 -0
  51. package/dist/docs/docs.json +1010 -0
  52. package/dist/docs/vscode.css-custom-data.json +6 -0
  53. package/dist/docs/vscode.html-custom-data.json +133 -0
  54. package/dist/docs/web-types.json +413 -0
  55. package/dist/embed-config.d.ts +18 -0
  56. package/dist/embed-config.js +24 -0
  57. package/dist/enums.d.ts +10 -0
  58. package/dist/index.d.ts +74 -0
  59. package/dist/index.js +8 -0
  60. package/dist/loader.d.ts +2 -0
  61. package/dist/loader.js +13 -0
  62. package/dist/main.css +1 -0
  63. package/dist/runtime.d.ts +6 -0
  64. package/dist/types/components.d.ts +1 -0
  65. package/dist/types/lumina.d.ts +28 -0
  66. package/dist/types/preact.d.ts +36 -0
  67. package/dist/types/react.d.ts +47 -0
  68. package/dist/types/stencil.d.ts +35 -0
  69. package/dist/util/configuration.d.ts +16 -0
  70. package/package.json +99 -0
@@ -0,0 +1,1010 @@
1
+ {
2
+ "timestamp": "2025-08-22T14:33:57",
3
+ "compiler": {
4
+ "name": "@arcgis/lumina-compiler",
5
+ "version": "4.33.0-next.121",
6
+ "typescriptVersion": "5.8.3"
7
+ },
8
+ "components": [
9
+ {
10
+ "filePath": "src/components/chat-shell/chat-shell.tsx",
11
+ "tag": "arcgis-chat-shell",
12
+ "overview": "",
13
+ "readme": "",
14
+ "usage": {},
15
+ "docs": "",
16
+ "docsTags": [
17
+ {
18
+ "name": "superclass",
19
+ "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}"
20
+ }
21
+ ],
22
+ "encapsulation": "shadow",
23
+ "dependents": [],
24
+ "dependencies": [],
25
+ "dependencyGraph": {},
26
+ "props": [
27
+ {
28
+ "name": "aboutContent",
29
+ "type": "string",
30
+ "complexType": {
31
+ "original": "string",
32
+ "resolved": "string",
33
+ "references": {}
34
+ },
35
+ "mutable": true,
36
+ "attr": "about-content",
37
+ "reflectToAttr": false,
38
+ "docs": "",
39
+ "docsTags": [],
40
+ "default": "`\n <div style=\"padding: 20px\">\n <h2>Disclaimer</h2>\n <p>more info soon ...</p>\n </div>\n `",
41
+ "values": [
42
+ {
43
+ "type": "string"
44
+ }
45
+ ],
46
+ "optional": true,
47
+ "required": false
48
+ },
49
+ {
50
+ "name": "aboutVisible",
51
+ "type": "boolean",
52
+ "complexType": {
53
+ "original": "boolean",
54
+ "resolved": "boolean",
55
+ "references": {}
56
+ },
57
+ "mutable": true,
58
+ "attr": "about-visible",
59
+ "reflectToAttr": false,
60
+ "docs": "",
61
+ "docsTags": [],
62
+ "default": "false",
63
+ "values": [
64
+ {
65
+ "type": "boolean"
66
+ }
67
+ ],
68
+ "optional": true,
69
+ "required": false
70
+ },
71
+ {
72
+ "name": "chatComponent",
73
+ "type": "unknown",
74
+ "complexType": {
75
+ "original": "unknown",
76
+ "resolved": "unknown",
77
+ "references": {}
78
+ },
79
+ "mutable": true,
80
+ "reflectToAttr": false,
81
+ "docs": "",
82
+ "docsTags": [],
83
+ "values": [],
84
+ "optional": true,
85
+ "required": false
86
+ },
87
+ {
88
+ "name": "featureTable",
89
+ "type": "ArcgisFeatureTable",
90
+ "complexType": {
91
+ "original": "ArcgisFeatureTable",
92
+ "resolved": "ArcgisFeatureTable",
93
+ "references": {
94
+ "ArcgisFeatureTable": {
95
+ "location": "import",
96
+ "path": "@arcgis/map-components/dist/components/arcgis-feature-table/customElement.d.ts",
97
+ "id": "notImplemented"
98
+ }
99
+ }
100
+ },
101
+ "mutable": true,
102
+ "reflectToAttr": false,
103
+ "docs": "",
104
+ "docsTags": [],
105
+ "values": [],
106
+ "optional": true,
107
+ "required": false
108
+ },
109
+ {
110
+ "name": "map",
111
+ "type": "LuminaArcgisMap",
112
+ "complexType": {
113
+ "original": "LuminaArcgisMap",
114
+ "resolved": "LuminaArcgisMap",
115
+ "references": {
116
+ "LuminaArcgisMap": {
117
+ "location": "import",
118
+ "path": "@arcgis/map-components/dist/types/lumina.d.ts",
119
+ "id": "notImplemented"
120
+ }
121
+ }
122
+ },
123
+ "mutable": true,
124
+ "reflectToAttr": false,
125
+ "docs": "",
126
+ "docsTags": [],
127
+ "values": [],
128
+ "optional": true,
129
+ "required": false
130
+ },
131
+ {
132
+ "name": "mapEnabled",
133
+ "type": "boolean",
134
+ "complexType": {
135
+ "original": "boolean",
136
+ "resolved": "boolean",
137
+ "references": {}
138
+ },
139
+ "mutable": true,
140
+ "attr": "map-enabled",
141
+ "reflectToAttr": false,
142
+ "docs": "",
143
+ "docsTags": [],
144
+ "default": "false",
145
+ "values": [
146
+ {
147
+ "type": "boolean"
148
+ }
149
+ ],
150
+ "optional": true,
151
+ "required": false
152
+ },
153
+ {
154
+ "name": "mapVisible",
155
+ "type": "boolean",
156
+ "complexType": {
157
+ "original": "boolean",
158
+ "resolved": "boolean",
159
+ "references": {}
160
+ },
161
+ "mutable": true,
162
+ "attr": "map-visible",
163
+ "reflectToAttr": false,
164
+ "docs": "",
165
+ "docsTags": [],
166
+ "default": "false",
167
+ "values": [
168
+ {
169
+ "type": "boolean"
170
+ }
171
+ ],
172
+ "optional": true,
173
+ "required": false
174
+ }
175
+ ],
176
+ "methods": [
177
+ {
178
+ "name": "componentOnReady",
179
+ "returns": {
180
+ "type": "Promise<void>",
181
+ "docs": ""
182
+ },
183
+ "complexType": {
184
+ "signature": "(): Promise<void>",
185
+ "parameters": [],
186
+ "return": "Promise<void>",
187
+ "references": {
188
+ "Promise": {
189
+ "location": "import",
190
+ "path": "typescript/lib/lib.es5.d.ts",
191
+ "id": "notImplemented"
192
+ }
193
+ }
194
+ },
195
+ "signature": "componentOnReady(): Promise<void>",
196
+ "parameters": [],
197
+ "docs": "Create a promise that resolves once component is fully loaded.",
198
+ "docsTags": [
199
+ {
200
+ "name": "example",
201
+ "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});"
202
+ },
203
+ {
204
+ "name": "inheritedFrom",
205
+ "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}"
206
+ }
207
+ ]
208
+ }
209
+ ],
210
+ "events": [
211
+ {
212
+ "event": "arcgisUpdateMapVisibility",
213
+ "detail": "boolean",
214
+ "bubbles": true,
215
+ "complexType": {
216
+ "original": "boolean",
217
+ "resolved": "boolean",
218
+ "references": {}
219
+ },
220
+ "cancelable": true,
221
+ "composed": true,
222
+ "docs": "",
223
+ "docsTags": []
224
+ }
225
+ ],
226
+ "styles": [],
227
+ "slots": [],
228
+ "parts": [],
229
+ "listeners": []
230
+ },
231
+ {
232
+ "filePath": "src/components/chat-ui/chat-ui.tsx",
233
+ "tag": "arcgis-chat-ui",
234
+ "overview": "",
235
+ "readme": "",
236
+ "usage": {},
237
+ "docs": "",
238
+ "docsTags": [
239
+ {
240
+ "name": "superclass",
241
+ "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}"
242
+ }
243
+ ],
244
+ "encapsulation": "shadow",
245
+ "dependents": [],
246
+ "dependencies": [],
247
+ "dependencyGraph": {},
248
+ "props": [
249
+ {
250
+ "name": "botDescription",
251
+ "type": "string",
252
+ "complexType": {
253
+ "original": "string",
254
+ "resolved": "string",
255
+ "references": {}
256
+ },
257
+ "mutable": true,
258
+ "attr": "bot-description",
259
+ "reflectToAttr": false,
260
+ "docs": "The disclaimer text for the AI assistant",
261
+ "docsTags": [],
262
+ "default": "\"\"",
263
+ "values": [
264
+ {
265
+ "type": "string"
266
+ }
267
+ ],
268
+ "optional": true,
269
+ "required": false
270
+ },
271
+ {
272
+ "name": "botTitle",
273
+ "type": "string",
274
+ "complexType": {
275
+ "original": "string",
276
+ "resolved": "string",
277
+ "references": {}
278
+ },
279
+ "mutable": true,
280
+ "attr": "bot-title",
281
+ "reflectToAttr": false,
282
+ "docs": "The title of the AI assistant",
283
+ "docsTags": [],
284
+ "default": "\"\"",
285
+ "values": [
286
+ {
287
+ "type": "string"
288
+ }
289
+ ],
290
+ "optional": true,
291
+ "required": false
292
+ },
293
+ {
294
+ "name": "conversationId",
295
+ "type": "string",
296
+ "complexType": {
297
+ "original": "string",
298
+ "resolved": "string",
299
+ "references": {}
300
+ },
301
+ "mutable": true,
302
+ "attr": "conversation-id",
303
+ "reflectToAttr": false,
304
+ "docs": "The current conversation ID, or null if starting a new conversation.",
305
+ "docsTags": [],
306
+ "values": [
307
+ {
308
+ "type": "string"
309
+ }
310
+ ],
311
+ "optional": true,
312
+ "required": false
313
+ },
314
+ {
315
+ "name": "defaultSuggestions",
316
+ "type": "Array<string | {\n icon: string;\n label: string;\n query: string | Array<string>;\n}>",
317
+ "complexType": {
318
+ "original": "Array<string | {\n icon: string;\n label: string;\n query: string | Array<string>;\n}>",
319
+ "resolved": "Array<string | {\n icon: string;\n label: string;\n query: string | Array<string>;\n}>",
320
+ "references": {
321
+ "Array": {
322
+ "location": "import",
323
+ "path": "typescript/lib/lib.es5.d.ts",
324
+ "id": "notImplemented"
325
+ }
326
+ }
327
+ },
328
+ "mutable": true,
329
+ "reflectToAttr": false,
330
+ "docs": "The default suggestions prompted to the user",
331
+ "docsTags": [],
332
+ "values": [],
333
+ "optional": true,
334
+ "required": false
335
+ },
336
+ {
337
+ "name": "devFeatureMessage",
338
+ "type": "({\n kind?: string | undefined;\n text?: string | undefined;\n actions?: Array<FinderAction> | undefined;\n sources?: Array<FinderSource> | undefined;\n location?: FinderLocation | undefined;\n features?: unknown;\n tools?: Array<FinderTool> | undefined;\n} & {\n author: string;\n text: string;\n messageId?: number | undefined;\n})",
339
+ "complexType": {
340
+ "original": "({\n kind?: string | undefined;\n text?: string | undefined;\n actions?: Array<FinderAction> | undefined;\n sources?: Array<FinderSource> | undefined;\n location?: FinderLocation | undefined;\n features?: unknown;\n tools?: Array<FinderTool> | undefined;\n} & {\n author: string;\n text: string;\n messageId?: number | undefined;\n})",
341
+ "resolved": "({\n kind?: string | undefined;\n text?: string | undefined;\n actions?: Array<FinderAction> | undefined;\n sources?: Array<FinderSource> | undefined;\n location?: FinderLocation | undefined;\n features?: unknown;\n tools?: Array<FinderTool> | undefined;\n} & {\n author: string;\n text: string;\n messageId?: number | undefined;\n})",
342
+ "references": {}
343
+ },
344
+ "mutable": true,
345
+ "reflectToAttr": false,
346
+ "docs": "Stores a developer feature message for quick testing or shortcuts.",
347
+ "docsTags": [],
348
+ "values": [],
349
+ "optional": true,
350
+ "required": false
351
+ },
352
+ {
353
+ "name": "getFinderResponse",
354
+ "type": "(message: string, conversationId: string | null) => Promise<Array<ArcgisErrorResponse> | Array<FinderSkillResponse>>",
355
+ "complexType": {
356
+ "original": "(message: string, conversationId: string | null) => Promise<Array<ArcgisErrorResponse> | Array<FinderSkillResponse>>",
357
+ "resolved": "(message: string, conversationId: string | null) => Promise<Array<ArcgisErrorResponse> | Array<FinderSkillResponse>>",
358
+ "references": {
359
+ "Promise": {
360
+ "location": "import",
361
+ "path": "typescript/lib/lib.es5.d.ts",
362
+ "id": "notImplemented"
363
+ },
364
+ "Array": {
365
+ "location": "import",
366
+ "path": "typescript/lib/lib.es5.d.ts",
367
+ "id": "notImplemented"
368
+ },
369
+ "ArcgisErrorResponse": {
370
+ "location": "local",
371
+ "path": "dist/components/arcgis-hub-ai-assistant/util/framework.d.ts",
372
+ "id": "notImplemented"
373
+ },
374
+ "FinderSkillResponse": {
375
+ "location": "local",
376
+ "path": "dist/components/arcgis-hub-ai-assistant/util/framework.d.ts",
377
+ "id": "notImplemented"
378
+ }
379
+ }
380
+ },
381
+ "mutable": true,
382
+ "reflectToAttr": false,
383
+ "docs": "Function property to get a Finder response.\nShould be provided by the parent component, `hub-ai-assistant`.",
384
+ "docsTags": [
385
+ {
386
+ "name": "param",
387
+ "text": "message - The user message to send."
388
+ },
389
+ {
390
+ "name": "param",
391
+ "text": "conversationId - The current conversation ID, or null to start a new conversation."
392
+ },
393
+ {
394
+ "name": "returns",
395
+ "text": "A promise resolving to an array of ArcgisErrorResponse or FinderSkillResponse."
396
+ }
397
+ ],
398
+ "values": [],
399
+ "optional": true,
400
+ "required": false
401
+ },
402
+ {
403
+ "name": "inputText",
404
+ "type": "string",
405
+ "complexType": {
406
+ "original": "string",
407
+ "resolved": "string",
408
+ "references": {}
409
+ },
410
+ "mutable": true,
411
+ "attr": "input-text",
412
+ "reflectToAttr": false,
413
+ "docs": "The current text input value from the user.",
414
+ "docsTags": [],
415
+ "default": "\"\"",
416
+ "values": [
417
+ {
418
+ "type": "string"
419
+ }
420
+ ],
421
+ "optional": true,
422
+ "required": false
423
+ }
424
+ ],
425
+ "methods": [
426
+ {
427
+ "name": "componentOnReady",
428
+ "returns": {
429
+ "type": "Promise<void>",
430
+ "docs": ""
431
+ },
432
+ "complexType": {
433
+ "signature": "(): Promise<void>",
434
+ "parameters": [],
435
+ "return": "Promise<void>",
436
+ "references": {
437
+ "Promise": {
438
+ "location": "import",
439
+ "path": "typescript/lib/lib.es5.d.ts",
440
+ "id": "notImplemented"
441
+ }
442
+ }
443
+ },
444
+ "signature": "componentOnReady(): Promise<void>",
445
+ "parameters": [],
446
+ "docs": "Create a promise that resolves once component is fully loaded.",
447
+ "docsTags": [
448
+ {
449
+ "name": "example",
450
+ "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});"
451
+ },
452
+ {
453
+ "name": "inheritedFrom",
454
+ "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}"
455
+ }
456
+ ]
457
+ },
458
+ {
459
+ "name": "submitUserMessage",
460
+ "returns": {
461
+ "type": "void",
462
+ "docs": ""
463
+ },
464
+ "complexType": {
465
+ "signature": "(text: string): void",
466
+ "parameters": [
467
+ {
468
+ "name": "text",
469
+ "type": "string",
470
+ "docs": ""
471
+ }
472
+ ],
473
+ "return": "void",
474
+ "references": {}
475
+ },
476
+ "signature": "submitUserMessage(text: string): void",
477
+ "parameters": [
478
+ {
479
+ "name": "text",
480
+ "type": "string",
481
+ "docs": ""
482
+ }
483
+ ],
484
+ "docs": "Submits the user's message to the chat.\nClears the input, adds the message to the chat history, and triggers the AI response.\nCurrently using the",
485
+ "docsTags": [
486
+ {
487
+ "name": "method",
488
+ "text": "decorator to expose this method to the DOM,\nallowing it to be called from `embed-modal.html`. Once this application has been migrated,\nI assume there will be no need for the html component and the"
489
+ },
490
+ {
491
+ "name": "method",
492
+ "text": "decorator can be removed."
493
+ },
494
+ {
495
+ "name": "param",
496
+ "text": "text The user's input message."
497
+ }
498
+ ]
499
+ }
500
+ ],
501
+ "events": [
502
+ {
503
+ "event": "arcgisAddDataClick",
504
+ "detail": "{\n type: \"dataset\";\n title?: string | undefined;\n data: DataItem;\n}",
505
+ "bubbles": true,
506
+ "complexType": {
507
+ "original": "{\n type: \"dataset\";\n title?: string | undefined;\n data: DataItem;\n}",
508
+ "resolved": "{\n type: \"dataset\";\n title?: string | undefined;\n data: DataItem;\n}",
509
+ "references": {}
510
+ },
511
+ "cancelable": true,
512
+ "composed": true,
513
+ "docs": "Event emitted when the user clicks to add data from a chat message.",
514
+ "docsTags": []
515
+ },
516
+ {
517
+ "event": "arcgisLocationClick",
518
+ "detail": "FinderLocation",
519
+ "bubbles": true,
520
+ "complexType": {
521
+ "original": "FinderLocation",
522
+ "resolved": "FinderLocation",
523
+ "references": {
524
+ "FinderLocation": {
525
+ "location": "local",
526
+ "path": "dist/components/arcgis-hub-ai-assistant/util/framework.d.ts",
527
+ "id": "notImplemented"
528
+ }
529
+ }
530
+ },
531
+ "cancelable": true,
532
+ "composed": true,
533
+ "docs": "Event emitted when the user clicks a zoom to location button in a chat message.",
534
+ "docsTags": []
535
+ }
536
+ ],
537
+ "styles": [],
538
+ "slots": [],
539
+ "parts": [],
540
+ "listeners": []
541
+ },
542
+ {
543
+ "filePath": "src/components/hub-ai-assistant/hub-ai-assistant.tsx",
544
+ "tag": "arcgis-hub-ai-assistant",
545
+ "overview": "",
546
+ "readme": "",
547
+ "usage": {},
548
+ "docs": "",
549
+ "docsTags": [
550
+ {
551
+ "name": "superclass",
552
+ "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}"
553
+ }
554
+ ],
555
+ "encapsulation": "none",
556
+ "dependents": [],
557
+ "dependencies": [],
558
+ "dependencyGraph": {},
559
+ "props": [
560
+ {
561
+ "name": "apiUrl",
562
+ "type": "string",
563
+ "complexType": {
564
+ "original": "string",
565
+ "resolved": "string",
566
+ "references": {}
567
+ },
568
+ "mutable": true,
569
+ "attr": "api-url",
570
+ "reflectToAttr": false,
571
+ "docs": "The API endpoint for the AI assistant's backend service.",
572
+ "docsTags": [],
573
+ "default": "\"/api/assistants/v1\"",
574
+ "values": [
575
+ {
576
+ "type": "string"
577
+ }
578
+ ],
579
+ "optional": true,
580
+ "required": false
581
+ },
582
+ {
583
+ "name": "authentication",
584
+ "type": "ArcGISIdentityManager",
585
+ "complexType": {
586
+ "original": "ArcGISIdentityManager",
587
+ "resolved": "ArcGISIdentityManager",
588
+ "references": {
589
+ "ArcGISIdentityManager": {
590
+ "location": "import",
591
+ "path": "@esri/arcgis-rest-request/dist/esm/ArcGISIdentityManager.d.ts",
592
+ "id": "notImplemented"
593
+ }
594
+ }
595
+ },
596
+ "mutable": true,
597
+ "reflectToAttr": false,
598
+ "docs": "",
599
+ "docsTags": [],
600
+ "values": [],
601
+ "optional": true,
602
+ "required": false
603
+ },
604
+ {
605
+ "name": "botDescription",
606
+ "type": "string",
607
+ "complexType": {
608
+ "original": "string",
609
+ "resolved": "string",
610
+ "references": {}
611
+ },
612
+ "mutable": true,
613
+ "attr": "bot-description",
614
+ "reflectToAttr": false,
615
+ "docs": "Basic info about the bot to display in the \"About\" panel",
616
+ "docsTags": [],
617
+ "default": "\"Hub AI Assistant helps you find and use open data in your community.\"",
618
+ "values": [
619
+ {
620
+ "type": "string"
621
+ }
622
+ ],
623
+ "optional": true,
624
+ "required": false
625
+ },
626
+ {
627
+ "name": "botTitle",
628
+ "type": "string",
629
+ "complexType": {
630
+ "original": "string",
631
+ "resolved": "string",
632
+ "references": {}
633
+ },
634
+ "mutable": true,
635
+ "attr": "bot-title",
636
+ "reflectToAttr": false,
637
+ "docs": "The title of the AI assistant bot, displayed in the UI.",
638
+ "docsTags": [],
639
+ "default": "\"Hub AI Assistant\"",
640
+ "values": [
641
+ {
642
+ "type": "string"
643
+ }
644
+ ],
645
+ "optional": true,
646
+ "required": false
647
+ },
648
+ {
649
+ "name": "context",
650
+ "type": "string",
651
+ "complexType": {
652
+ "original": "string",
653
+ "resolved": "string",
654
+ "references": {}
655
+ },
656
+ "mutable": true,
657
+ "attr": "context",
658
+ "reflectToAttr": false,
659
+ "docs": "Context such as organization or theme for this AI Assistant\ne.g. \"USGS\" or \"Oceans\"",
660
+ "docsTags": [],
661
+ "values": [
662
+ {
663
+ "type": "string"
664
+ }
665
+ ],
666
+ "optional": true,
667
+ "required": false
668
+ },
669
+ {
670
+ "name": "defaultSuggestions",
671
+ "type": "Array<string | {\n icon: string;\n label: string;\n query: string | Array<string>;\n}>",
672
+ "complexType": {
673
+ "original": "Array<string | {\n icon: string;\n label: string;\n query: string | Array<string>;\n}>",
674
+ "resolved": "Array<string | {\n icon: string;\n label: string;\n query: string | Array<string>;\n}>",
675
+ "references": {
676
+ "Array": {
677
+ "location": "import",
678
+ "path": "typescript/lib/lib.es5.d.ts",
679
+ "id": "notImplemented"
680
+ }
681
+ }
682
+ },
683
+ "mutable": true,
684
+ "reflectToAttr": false,
685
+ "docs": "The default suggestions for the user",
686
+ "docsTags": [],
687
+ "values": [],
688
+ "optional": true,
689
+ "required": false
690
+ },
691
+ {
692
+ "name": "entityId",
693
+ "type": "string",
694
+ "complexType": {
695
+ "original": "string",
696
+ "resolved": "string",
697
+ "references": {}
698
+ },
699
+ "mutable": true,
700
+ "attr": "entity-id",
701
+ "reflectToAttr": false,
702
+ "docs": "For information queries (infererence) which entity to get pages + documents",
703
+ "docsTags": [],
704
+ "values": [
705
+ {
706
+ "type": "string"
707
+ }
708
+ ],
709
+ "optional": true,
710
+ "required": false
711
+ },
712
+ {
713
+ "name": "extent",
714
+ "type": "Array<Array<number>>",
715
+ "complexType": {
716
+ "original": "Array<Array<number>>",
717
+ "resolved": "Array<Array<number>>",
718
+ "references": {
719
+ "Array": {
720
+ "location": "import",
721
+ "path": "typescript/lib/lib.es5.d.ts",
722
+ "id": "notImplemented"
723
+ }
724
+ }
725
+ },
726
+ "mutable": true,
727
+ "reflectToAttr": false,
728
+ "docs": "The default map extent (bounding box) to use for the map view.\nFormat: [[minX, minY], [maxX, maxY]]",
729
+ "docsTags": [],
730
+ "values": [],
731
+ "optional": true,
732
+ "required": false
733
+ },
734
+ {
735
+ "name": "hub",
736
+ "type": "string",
737
+ "complexType": {
738
+ "original": "string",
739
+ "resolved": "string",
740
+ "references": {}
741
+ },
742
+ "mutable": true,
743
+ "attr": "hub",
744
+ "reflectToAttr": false,
745
+ "docs": "Hub domain to use for finding relevant datasets",
746
+ "docsTags": [],
747
+ "default": "\"opendata.dc.gov\"",
748
+ "values": [
749
+ {
750
+ "type": "string"
751
+ }
752
+ ],
753
+ "optional": true,
754
+ "required": false
755
+ },
756
+ {
757
+ "name": "itemId",
758
+ "type": "string",
759
+ "complexType": {
760
+ "original": "string",
761
+ "resolved": "string",
762
+ "references": {}
763
+ },
764
+ "mutable": true,
765
+ "attr": "item-id",
766
+ "reflectToAttr": false,
767
+ "docs": "ArcGIS Item id for assistant configuration",
768
+ "docsTags": [],
769
+ "values": [
770
+ {
771
+ "type": "string"
772
+ }
773
+ ],
774
+ "optional": true,
775
+ "required": false
776
+ },
777
+ {
778
+ "name": "language",
779
+ "type": "string",
780
+ "complexType": {
781
+ "original": "string",
782
+ "resolved": "string",
783
+ "references": {}
784
+ },
785
+ "mutable": true,
786
+ "attr": "language",
787
+ "reflectToAttr": false,
788
+ "docs": "Language for the chatbot to use",
789
+ "docsTags": [],
790
+ "values": [
791
+ {
792
+ "type": "string"
793
+ }
794
+ ],
795
+ "optional": true,
796
+ "required": false
797
+ },
798
+ {
799
+ "name": "location",
800
+ "type": "string",
801
+ "complexType": {
802
+ "original": "string",
803
+ "resolved": "string",
804
+ "references": {}
805
+ },
806
+ "mutable": true,
807
+ "attr": "location",
808
+ "reflectToAttr": false,
809
+ "docs": "Default geographic location to limit / focus results",
810
+ "docsTags": [],
811
+ "default": "\"Washington, DC\"",
812
+ "values": [
813
+ {
814
+ "type": "string"
815
+ }
816
+ ],
817
+ "optional": true,
818
+ "required": false
819
+ },
820
+ {
821
+ "name": "mapBasemap",
822
+ "type": "string",
823
+ "complexType": {
824
+ "original": "string",
825
+ "resolved": "string",
826
+ "references": {}
827
+ },
828
+ "mutable": true,
829
+ "attr": "map-basemap",
830
+ "reflectToAttr": false,
831
+ "docs": "The basemap for the map. List of options:\nhttps://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#basemap",
832
+ "docsTags": [],
833
+ "default": "\"gray-vector\"",
834
+ "values": [
835
+ {
836
+ "type": "string"
837
+ }
838
+ ],
839
+ "optional": true,
840
+ "required": false
841
+ },
842
+ {
843
+ "name": "mapEnabled",
844
+ "type": "boolean",
845
+ "complexType": {
846
+ "original": "boolean",
847
+ "resolved": "boolean",
848
+ "references": {}
849
+ },
850
+ "mutable": true,
851
+ "attr": "map-enabled",
852
+ "reflectToAttr": false,
853
+ "docs": "If the map is enabled (able to be togged on within the component).",
854
+ "docsTags": [],
855
+ "default": "false",
856
+ "values": [
857
+ {
858
+ "type": "boolean"
859
+ }
860
+ ],
861
+ "optional": true,
862
+ "required": false
863
+ },
864
+ {
865
+ "name": "mapLayers",
866
+ "type": "Array<string>",
867
+ "complexType": {
868
+ "original": "Array<string>",
869
+ "resolved": "Array<string>",
870
+ "references": {
871
+ "Array": {
872
+ "location": "import",
873
+ "path": "typescript/lib/lib.es5.d.ts",
874
+ "id": "notImplemented"
875
+ }
876
+ }
877
+ },
878
+ "mutable": true,
879
+ "reflectToAttr": false,
880
+ "docs": "Portal IDs of the layers on the map",
881
+ "docsTags": [],
882
+ "values": [],
883
+ "optional": true,
884
+ "required": false
885
+ },
886
+ {
887
+ "name": "mapShowTable",
888
+ "type": "boolean",
889
+ "complexType": {
890
+ "original": "boolean",
891
+ "resolved": "boolean",
892
+ "references": {}
893
+ },
894
+ "mutable": true,
895
+ "attr": "map-show-table",
896
+ "reflectToAttr": false,
897
+ "docs": "In the map, option to show the \"Table\" widget.",
898
+ "docsTags": [],
899
+ "default": "false",
900
+ "values": [
901
+ {
902
+ "type": "boolean"
903
+ }
904
+ ],
905
+ "optional": true,
906
+ "required": false
907
+ },
908
+ {
909
+ "name": "mapVisible",
910
+ "type": "boolean",
911
+ "complexType": {
912
+ "original": "boolean",
913
+ "resolved": "boolean",
914
+ "references": {}
915
+ },
916
+ "mutable": true,
917
+ "attr": "map-visible",
918
+ "reflectToAttr": false,
919
+ "docs": "If the map is currently visible. Only applicable if `mapEnabled` is true.",
920
+ "docsTags": [],
921
+ "default": "false",
922
+ "values": [
923
+ {
924
+ "type": "boolean"
925
+ }
926
+ ],
927
+ "optional": true,
928
+ "required": false
929
+ },
930
+ {
931
+ "name": "portalUrl",
932
+ "type": "string",
933
+ "complexType": {
934
+ "original": "string",
935
+ "resolved": "string",
936
+ "references": {}
937
+ },
938
+ "mutable": true,
939
+ "attr": "portal-url",
940
+ "reflectToAttr": false,
941
+ "docs": "The base URL of the ArcGIS portal to use for authentication and data requests.",
942
+ "docsTags": [],
943
+ "default": "\"\"",
944
+ "values": [
945
+ {
946
+ "type": "string"
947
+ }
948
+ ],
949
+ "optional": true,
950
+ "required": false
951
+ }
952
+ ],
953
+ "methods": [
954
+ {
955
+ "name": "componentOnReady",
956
+ "returns": {
957
+ "type": "Promise<void>",
958
+ "docs": ""
959
+ },
960
+ "complexType": {
961
+ "signature": "(): Promise<void>",
962
+ "parameters": [],
963
+ "return": "Promise<void>",
964
+ "references": {
965
+ "Promise": {
966
+ "location": "import",
967
+ "path": "typescript/lib/lib.es5.d.ts",
968
+ "id": "notImplemented"
969
+ }
970
+ }
971
+ },
972
+ "signature": "componentOnReady(): Promise<void>",
973
+ "parameters": [],
974
+ "docs": "Create a promise that resolves once component is fully loaded.",
975
+ "docsTags": [
976
+ {
977
+ "name": "example",
978
+ "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});"
979
+ },
980
+ {
981
+ "name": "inheritedFrom",
982
+ "text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}"
983
+ }
984
+ ]
985
+ }
986
+ ],
987
+ "events": [
988
+ {
989
+ "event": "arcgisAddLayer",
990
+ "detail": "undefined",
991
+ "bubbles": true,
992
+ "complexType": {
993
+ "original": "undefined",
994
+ "resolved": "undefined",
995
+ "references": {}
996
+ },
997
+ "cancelable": true,
998
+ "composed": true,
999
+ "docs": "",
1000
+ "docsTags": []
1001
+ }
1002
+ ],
1003
+ "styles": [],
1004
+ "slots": [],
1005
+ "parts": [],
1006
+ "listeners": []
1007
+ }
1008
+ ],
1009
+ "typeLibrary": {}
1010
+ }