@vertigis/viewer-spec 58.5.0 → 58.7.0
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.
- package/messaging/Event.d.ts +1 -1
- package/messaging/registry/ui.d.ts +18 -3
- package/messaging/schema/common-action.schema.json +42 -1
- package/messaging/schema/mobile-action.schema.json +42 -1
- package/messaging/schema/web-action.schema.json +42 -1
- package/package.json +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
package/messaging/Event.d.ts
CHANGED
|
@@ -3,7 +3,7 @@ import type { Model } from "./common.js";
|
|
|
3
3
|
/**
|
|
4
4
|
* A callback that will be invoked whenever the event is published.
|
|
5
5
|
*/
|
|
6
|
-
export type EventCallback<T> = (arg?: T, publisher?: Model) => void | Promise<void>;
|
|
6
|
+
export type EventCallback<T> = (arg?: T, publisher?: Model, eventName?: string) => void | Promise<void>;
|
|
7
7
|
/**
|
|
8
8
|
* A named event.
|
|
9
9
|
*/
|
|
@@ -82,6 +82,11 @@ export interface PromptOperationArgs extends MessageBoxArgs {
|
|
|
82
82
|
* The arguments for the `ui.display-notification` command.
|
|
83
83
|
*/
|
|
84
84
|
export interface DisplayNotificationArgs {
|
|
85
|
+
/**
|
|
86
|
+
* Optional identifier that can be used to hide a particular notification
|
|
87
|
+
* (see `ui.hide-notification`) Web only.
|
|
88
|
+
*/
|
|
89
|
+
id?: string;
|
|
85
90
|
/**
|
|
86
91
|
* The category of notification, i.e. "error" (default is "info").
|
|
87
92
|
*/
|
|
@@ -121,11 +126,21 @@ export interface DisplayNotificationArgs {
|
|
|
121
126
|
*/
|
|
122
127
|
autoClose?: boolean;
|
|
123
128
|
/**
|
|
124
|
-
*
|
|
125
|
-
* only.
|
|
129
|
+
* Invoked when the notification is closed, either explicitly or due to
|
|
130
|
+
* timeout. Web only.
|
|
126
131
|
*/
|
|
127
132
|
onClose?: () => void;
|
|
128
133
|
}
|
|
134
|
+
/**
|
|
135
|
+
* The arguments for the `ui.hide-notification` command.
|
|
136
|
+
*/
|
|
137
|
+
export interface HideNotificationArgs {
|
|
138
|
+
/**
|
|
139
|
+
* Optional identifier that can be used to hide a particular notification.
|
|
140
|
+
* Web only.
|
|
141
|
+
*/
|
|
142
|
+
id?: string;
|
|
143
|
+
}
|
|
129
144
|
/**
|
|
130
145
|
* The type of notification - 'app', 'system', or 'auto'. Defaults to 'auto'.
|
|
131
146
|
* Mobile only.
|
|
@@ -347,7 +362,7 @@ export declare class UICommands extends CommandRegistry {
|
|
|
347
362
|
/**
|
|
348
363
|
* Hides a notification previously shown to the user.
|
|
349
364
|
*/
|
|
350
|
-
get hideNotification(): Command
|
|
365
|
+
get hideNotification(): Command<HideNotificationArgs | void>;
|
|
351
366
|
/**
|
|
352
367
|
* Marks a component as being available. The interpretation of what effect
|
|
353
368
|
* this has is up to the component. Currently the only component that will
|
|
@@ -1470,6 +1470,10 @@
|
|
|
1470
1470
|
"description": "Disable notification timeouts. Timeouts only apply to \"info\" and \"success\" categories. Web only.",
|
|
1471
1471
|
"type": "boolean"
|
|
1472
1472
|
},
|
|
1473
|
+
"id": {
|
|
1474
|
+
"description": "Optional identifier that can be used to hide a particular notification (see `ui.hide-notification`) Web only.",
|
|
1475
|
+
"type": "string"
|
|
1476
|
+
},
|
|
1473
1477
|
"message": {
|
|
1474
1478
|
"$ref": "#/definitions/TranslatableText",
|
|
1475
1479
|
"description": "The message to be displayed in the notification. Mobile only supports a string for this property."
|
|
@@ -1480,7 +1484,7 @@
|
|
|
1480
1484
|
},
|
|
1481
1485
|
"onClose": {
|
|
1482
1486
|
"$ref": "__type",
|
|
1483
|
-
"description": "
|
|
1487
|
+
"description": "Invoked when the notification is closed, either explicitly or due to timeout. Web only."
|
|
1484
1488
|
},
|
|
1485
1489
|
"position": {
|
|
1486
1490
|
"$ref": "Position",
|
|
@@ -2231,6 +2235,17 @@
|
|
|
2231
2235
|
},
|
|
2232
2236
|
"type": "object"
|
|
2233
2237
|
},
|
|
2238
|
+
"HideNotificationArgs": {
|
|
2239
|
+
"additionalProperties": false,
|
|
2240
|
+
"description": "The arguments for the `ui.hide-notification` command.",
|
|
2241
|
+
"properties": {
|
|
2242
|
+
"id": {
|
|
2243
|
+
"description": "Optional identifier that can be used to hide a particular notification. Web only.",
|
|
2244
|
+
"type": "string"
|
|
2245
|
+
}
|
|
2246
|
+
},
|
|
2247
|
+
"type": "object"
|
|
2248
|
+
},
|
|
2234
2249
|
"IdentifyArgs": {
|
|
2235
2250
|
"additionalProperties": false,
|
|
2236
2251
|
"description": "Arguments for the tasks.identify operation.",
|
|
@@ -14328,6 +14343,16 @@
|
|
|
14328
14343
|
"ui.hide-notification"
|
|
14329
14344
|
]
|
|
14330
14345
|
},
|
|
14346
|
+
"ui.hide-notification:input": {
|
|
14347
|
+
"anyOf": [
|
|
14348
|
+
{
|
|
14349
|
+
"$ref": "#/definitions/HideNotificationArgs"
|
|
14350
|
+
},
|
|
14351
|
+
{
|
|
14352
|
+
"type": "null"
|
|
14353
|
+
}
|
|
14354
|
+
]
|
|
14355
|
+
},
|
|
14331
14356
|
"ui.set-theme": {
|
|
14332
14357
|
"description": "Sets the color theme of the viewer. The required argument is the new theme's ID.",
|
|
14333
14358
|
"enum": [
|
|
@@ -15178,6 +15203,22 @@
|
|
|
15178
15203
|
],
|
|
15179
15204
|
"type": "object"
|
|
15180
15205
|
},
|
|
15206
|
+
{
|
|
15207
|
+
"additionalProperties": false,
|
|
15208
|
+
"properties": {
|
|
15209
|
+
"arguments": {
|
|
15210
|
+
"$ref": "#/definitions/ui.hide-notification:input"
|
|
15211
|
+
},
|
|
15212
|
+
"name": {
|
|
15213
|
+
"$ref": "#/definitions/ui.hide-notification"
|
|
15214
|
+
}
|
|
15215
|
+
},
|
|
15216
|
+
"required": [
|
|
15217
|
+
"name",
|
|
15218
|
+
"arguments"
|
|
15219
|
+
],
|
|
15220
|
+
"type": "object"
|
|
15221
|
+
},
|
|
15181
15222
|
{
|
|
15182
15223
|
"additionalProperties": false,
|
|
15183
15224
|
"properties": {
|
|
@@ -1698,6 +1698,10 @@
|
|
|
1698
1698
|
"description": "Disable notification timeouts. Timeouts only apply to \"info\" and \"success\" categories. Web only.",
|
|
1699
1699
|
"type": "boolean"
|
|
1700
1700
|
},
|
|
1701
|
+
"id": {
|
|
1702
|
+
"description": "Optional identifier that can be used to hide a particular notification (see `ui.hide-notification`) Web only.",
|
|
1703
|
+
"type": "string"
|
|
1704
|
+
},
|
|
1701
1705
|
"message": {
|
|
1702
1706
|
"$ref": "#/definitions/TranslatableText",
|
|
1703
1707
|
"description": "The message to be displayed in the notification. Mobile only supports a string for this property."
|
|
@@ -1708,7 +1712,7 @@
|
|
|
1708
1712
|
},
|
|
1709
1713
|
"onClose": {
|
|
1710
1714
|
"$ref": "__type",
|
|
1711
|
-
"description": "
|
|
1715
|
+
"description": "Invoked when the notification is closed, either explicitly or due to timeout. Web only."
|
|
1712
1716
|
},
|
|
1713
1717
|
"position": {
|
|
1714
1718
|
"$ref": "Position",
|
|
@@ -2706,6 +2710,17 @@
|
|
|
2706
2710
|
],
|
|
2707
2711
|
"type": "object"
|
|
2708
2712
|
},
|
|
2713
|
+
"HideNotificationArgs": {
|
|
2714
|
+
"additionalProperties": false,
|
|
2715
|
+
"description": "The arguments for the `ui.hide-notification` command.",
|
|
2716
|
+
"properties": {
|
|
2717
|
+
"id": {
|
|
2718
|
+
"description": "Optional identifier that can be used to hide a particular notification. Web only.",
|
|
2719
|
+
"type": "string"
|
|
2720
|
+
}
|
|
2721
|
+
},
|
|
2722
|
+
"type": "object"
|
|
2723
|
+
},
|
|
2709
2724
|
"HostAndPortArgs": {
|
|
2710
2725
|
"additionalProperties": false,
|
|
2711
2726
|
"description": "Arguments for the network.can-reach-host operation.",
|
|
@@ -16487,6 +16502,16 @@
|
|
|
16487
16502
|
"ui.hide-notification"
|
|
16488
16503
|
]
|
|
16489
16504
|
},
|
|
16505
|
+
"ui.hide-notification:input": {
|
|
16506
|
+
"anyOf": [
|
|
16507
|
+
{
|
|
16508
|
+
"$ref": "#/definitions/HideNotificationArgs"
|
|
16509
|
+
},
|
|
16510
|
+
{
|
|
16511
|
+
"type": "null"
|
|
16512
|
+
}
|
|
16513
|
+
]
|
|
16514
|
+
},
|
|
16490
16515
|
"ui.make-available": {
|
|
16491
16516
|
"description": "Marks a component as being available. The interpretation of what effect this has is up to the component. Currently the only component that will react to this is the task-bar, which will have the effect of showing the tab/button for that component. The argument can be an id of the component, or the model for the component. Mobile only.",
|
|
16492
16517
|
"enum": [
|
|
@@ -18325,6 +18350,22 @@
|
|
|
18325
18350
|
],
|
|
18326
18351
|
"type": "object"
|
|
18327
18352
|
},
|
|
18353
|
+
{
|
|
18354
|
+
"additionalProperties": false,
|
|
18355
|
+
"properties": {
|
|
18356
|
+
"arguments": {
|
|
18357
|
+
"$ref": "#/definitions/ui.hide-notification:input"
|
|
18358
|
+
},
|
|
18359
|
+
"name": {
|
|
18360
|
+
"$ref": "#/definitions/ui.hide-notification"
|
|
18361
|
+
}
|
|
18362
|
+
},
|
|
18363
|
+
"required": [
|
|
18364
|
+
"name",
|
|
18365
|
+
"arguments"
|
|
18366
|
+
],
|
|
18367
|
+
"type": "object"
|
|
18368
|
+
},
|
|
18328
18369
|
{
|
|
18329
18370
|
"additionalProperties": false,
|
|
18330
18371
|
"properties": {
|
|
@@ -2329,6 +2329,10 @@
|
|
|
2329
2329
|
"description": "Disable notification timeouts. Timeouts only apply to \"info\" and \"success\" categories. Web only.",
|
|
2330
2330
|
"type": "boolean"
|
|
2331
2331
|
},
|
|
2332
|
+
"id": {
|
|
2333
|
+
"description": "Optional identifier that can be used to hide a particular notification (see `ui.hide-notification`) Web only.",
|
|
2334
|
+
"type": "string"
|
|
2335
|
+
},
|
|
2332
2336
|
"message": {
|
|
2333
2337
|
"$ref": "#/definitions/TranslatableText",
|
|
2334
2338
|
"description": "The message to be displayed in the notification. Mobile only supports a string for this property."
|
|
@@ -2339,7 +2343,7 @@
|
|
|
2339
2343
|
},
|
|
2340
2344
|
"onClose": {
|
|
2341
2345
|
"$ref": "__type",
|
|
2342
|
-
"description": "
|
|
2346
|
+
"description": "Invoked when the notification is closed, either explicitly or due to timeout. Web only."
|
|
2343
2347
|
},
|
|
2344
2348
|
"position": {
|
|
2345
2349
|
"$ref": "Position",
|
|
@@ -4458,6 +4462,17 @@
|
|
|
4458
4462
|
},
|
|
4459
4463
|
"type": "object"
|
|
4460
4464
|
},
|
|
4465
|
+
"HideNotificationArgs": {
|
|
4466
|
+
"additionalProperties": false,
|
|
4467
|
+
"description": "The arguments for the `ui.hide-notification` command.",
|
|
4468
|
+
"properties": {
|
|
4469
|
+
"id": {
|
|
4470
|
+
"description": "Optional identifier that can be used to hide a particular notification. Web only.",
|
|
4471
|
+
"type": "string"
|
|
4472
|
+
}
|
|
4473
|
+
},
|
|
4474
|
+
"type": "object"
|
|
4475
|
+
},
|
|
4461
4476
|
"IdentifyArgs": {
|
|
4462
4477
|
"additionalProperties": false,
|
|
4463
4478
|
"description": "Arguments for the tasks.identify operation.",
|
|
@@ -22718,6 +22733,16 @@
|
|
|
22718
22733
|
"ui.hide-notification"
|
|
22719
22734
|
]
|
|
22720
22735
|
},
|
|
22736
|
+
"ui.hide-notification:input": {
|
|
22737
|
+
"anyOf": [
|
|
22738
|
+
{
|
|
22739
|
+
"$ref": "#/definitions/HideNotificationArgs"
|
|
22740
|
+
},
|
|
22741
|
+
{
|
|
22742
|
+
"type": "null"
|
|
22743
|
+
}
|
|
22744
|
+
]
|
|
22745
|
+
},
|
|
22721
22746
|
"ui.narrate": {
|
|
22722
22747
|
"description": "Forces assistive technology (screen readers) to narrate a translatable message to the end user. Web only.",
|
|
22723
22748
|
"enum": [
|
|
@@ -25280,6 +25305,22 @@
|
|
|
25280
25305
|
],
|
|
25281
25306
|
"type": "object"
|
|
25282
25307
|
},
|
|
25308
|
+
{
|
|
25309
|
+
"additionalProperties": false,
|
|
25310
|
+
"properties": {
|
|
25311
|
+
"arguments": {
|
|
25312
|
+
"$ref": "#/definitions/ui.hide-notification:input"
|
|
25313
|
+
},
|
|
25314
|
+
"name": {
|
|
25315
|
+
"$ref": "#/definitions/ui.hide-notification"
|
|
25316
|
+
}
|
|
25317
|
+
},
|
|
25318
|
+
"required": [
|
|
25319
|
+
"name",
|
|
25320
|
+
"arguments"
|
|
25321
|
+
],
|
|
25322
|
+
"type": "object"
|
|
25323
|
+
},
|
|
25283
25324
|
{
|
|
25284
25325
|
"additionalProperties": false,
|
|
25285
25326
|
"properties": {
|
package/package.json
CHANGED
package/version.d.ts
CHANGED
package/version.js
CHANGED