@vertigis/viewer-spec 49.9.0 → 50.0.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.
Files changed (66) hide show
  1. package/README.md +1 -1
  2. package/analytics/MobileAction.d.ts +54 -0
  3. package/analytics/MobileAction.js +1 -0
  4. package/app-config/mobile/BasemapModelProperties.d.ts +1 -1
  5. package/app-config/mobile/VertigisMobileModelProperties.d.ts +2 -2
  6. package/app-config/schema/mobile-app-config.schema.json +1 -1
  7. package/app-config/schema/web-app-config.schema.json +1 -1
  8. package/app-config/web/ResultsModelProperties.d.ts +1 -1
  9. package/app-config/web/VertigisWebModelProperties.d.ts +2 -3
  10. package/docs/presentation.md +30 -23
  11. package/messaging/DotNetTypes.d.ts +4 -0
  12. package/messaging/DotNetTypes.js +1 -0
  13. package/messaging/common.d.ts +53 -2
  14. package/messaging/common.js +1 -1
  15. package/messaging/mobile.d.ts +1 -8
  16. package/messaging/registry/Events.d.ts +6 -0
  17. package/messaging/registry/Events.js +1 -1
  18. package/messaging/registry/app.d.ts +32 -32
  19. package/messaging/registry/app.js +1 -1
  20. package/messaging/registry/auth.d.ts +44 -11
  21. package/messaging/registry/auth.js +1 -1
  22. package/messaging/registry/basemap.d.ts +19 -1
  23. package/messaging/registry/basemap.js +1 -1
  24. package/messaging/registry/bookmark.d.ts +41 -0
  25. package/messaging/registry/bookmark.js +1 -0
  26. package/messaging/registry/device.d.ts +12 -0
  27. package/messaging/registry/device.js +1 -1
  28. package/messaging/registry/file.d.ts +10 -0
  29. package/messaging/registry/file.js +1 -1
  30. package/messaging/registry/geolocation.d.ts +163 -7
  31. package/messaging/registry/geolocation.js +1 -1
  32. package/messaging/registry/geometry-toolbar.d.ts +5 -5
  33. package/messaging/registry/highlights.d.ts +6 -7
  34. package/messaging/registry/map.d.ts +85 -14
  35. package/messaging/registry/map.js +1 -1
  36. package/messaging/registry/measurement.d.ts +36 -4
  37. package/messaging/registry/measurement.js +1 -1
  38. package/messaging/registry/offline.d.ts +6 -0
  39. package/messaging/registry/offline.js +1 -1
  40. package/messaging/registry/panel.d.ts +8 -1
  41. package/messaging/registry/panel.js +1 -1
  42. package/messaging/registry/photos.js +1 -1
  43. package/messaging/registry/results.d.ts +40 -0
  44. package/messaging/registry/results.js +1 -1
  45. package/messaging/registry/search.d.ts +31 -7
  46. package/messaging/registry/search.js +1 -1
  47. package/messaging/registry/settings.d.ts +40 -0
  48. package/messaging/registry/settings.js +1 -0
  49. package/messaging/registry/shortcut.d.ts +40 -0
  50. package/messaging/registry/shortcut.js +1 -0
  51. package/messaging/registry/sketching.d.ts +4 -4
  52. package/messaging/registry/system.d.ts +21 -0
  53. package/messaging/registry/system.js +1 -1
  54. package/messaging/registry/tasks.d.ts +26 -16
  55. package/messaging/registry/tasks.js +1 -1
  56. package/messaging/registry/ui.d.ts +4 -4
  57. package/messaging/registry/workflow.d.ts +6 -9
  58. package/messaging/schema/common-action.schema.json +43 -38
  59. package/messaging/schema/common-event.schema.json +193 -11
  60. package/messaging/schema/mobile-action.schema.json +91 -79
  61. package/messaging/schema/mobile-event.schema.json +1075 -107
  62. package/messaging/schema/web-action.schema.json +67 -62
  63. package/messaging/schema/web-event.schema.json +130 -20
  64. package/package.json +1 -1
  65. package/version.d.ts +1 -1
  66. package/version.js +1 -1
@@ -60,6 +60,9 @@
60
60
  },
61
61
  "geometry": {
62
62
  "anyOf": [
63
+ {
64
+ "$ref": "#/definitions/esri.Geometry"
65
+ },
63
66
  {
64
67
  "$ref": "#/definitions/esri.rest-api.Point.Point"
65
68
  },
@@ -74,9 +77,6 @@
74
77
  },
75
78
  {
76
79
  "$ref": "#/definitions/esri.rest-api.Extent.Extent"
77
- },
78
- {
79
- "$ref": "#/definitions/esri.Geometry"
80
80
  }
81
81
  ],
82
82
  "description": "The feature's geometry."
@@ -363,6 +363,10 @@
363
363
  },
364
364
  "type": "object"
365
365
  },
366
+ "ArcGISPortalIdentity": {
367
+ "additionalProperties": false,
368
+ "type": "object"
369
+ },
366
370
  "AuthenticationType": {
367
371
  "description": "A type of authentication.",
368
372
  "enum": [
@@ -446,6 +450,15 @@
446
450
  "GeolocationStatusChangedEventArgs": {
447
451
  "additionalProperties": false,
448
452
  "description": "Arguments for the \"geolocation.status-changed\" event.",
453
+ "properties": {
454
+ "isEnabled": {
455
+ "description": "Indicates whether the geolocation is now enabled.",
456
+ "type": "boolean"
457
+ }
458
+ },
459
+ "required": [
460
+ "isEnabled"
461
+ ],
449
462
  "type": "object"
450
463
  },
451
464
  "GeometryLike": {
@@ -481,6 +494,9 @@
481
494
  },
482
495
  "type": "array"
483
496
  },
497
+ {
498
+ "$ref": "#/definitions/esri.Geometry"
499
+ },
484
500
  {
485
501
  "$ref": "#/definitions/esri.rest-api.Feature.Feature"
486
502
  },
@@ -515,12 +531,12 @@
515
531
  {
516
532
  "$ref": "#/definitions/esri.rest-api.Extent.Extent"
517
533
  },
518
- {
519
- "$ref": "#/definitions/esri.Geometry"
520
- },
521
534
  {
522
535
  "items": {
523
536
  "anyOf": [
537
+ {
538
+ "$ref": "#/definitions/esri.Geometry"
539
+ },
524
540
  {
525
541
  "$ref": "#/definitions/esri.rest-api.Point.Point"
526
542
  },
@@ -535,9 +551,6 @@
535
551
  },
536
552
  {
537
553
  "$ref": "#/definitions/esri.rest-api.Extent.Extent"
538
- },
539
- {
540
- "$ref": "#/definitions/esri.Geometry"
541
554
  }
542
555
  ]
543
556
  },
@@ -550,6 +563,10 @@
550
563
  "additionalProperties": false,
551
564
  "description": "A geolocation source.",
552
565
  "properties": {
566
+ "deviceFullName": {
567
+ "description": "Full name of the GNSS device.",
568
+ "type": "string"
569
+ },
553
570
  "deviceName": {
554
571
  "description": "Name of the GNSS device.",
555
572
  "type": "string"
@@ -564,6 +581,7 @@
564
581
  }
565
582
  },
566
583
  "required": [
584
+ "deviceFullName",
567
585
  "deviceName",
568
586
  "deviceType",
569
587
  "settings"
@@ -690,11 +708,41 @@
690
708
  "additionalProperties": false,
691
709
  "description": "Arguments for the various map events.",
692
710
  "properties": {
711
+ "mapExtension": {
712
+ "$ref": "@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension",
713
+ "description": "The map extension for which the event was generated."
714
+ },
693
715
  "maps": {
694
716
  "$ref": "MapsLike",
695
717
  "description": "The map from which the event was generated."
696
718
  }
697
719
  },
720
+ "required": [
721
+ "mapExtension"
722
+ ],
723
+ "type": "object"
724
+ },
725
+ "MapInitializedEvent": {
726
+ "additionalProperties": false,
727
+ "description": "Event args for the map.initialized event.",
728
+ "properties": {
729
+ "loadTime": {
730
+ "$ref": "#/definitions/TimeSpan",
731
+ "description": "The amount of time that the map took to load. Mobile only."
732
+ },
733
+ "mapExtension": {
734
+ "$ref": "@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension",
735
+ "description": "The map extension for which the event was generated."
736
+ },
737
+ "maps": {
738
+ "$ref": "MapsLike",
739
+ "description": "The map from which the event was generated."
740
+ }
741
+ },
742
+ "required": [
743
+ "loadTime",
744
+ "mapExtension"
745
+ ],
698
746
  "type": "object"
699
747
  },
700
748
  "MapsLike": {
@@ -776,6 +824,14 @@
776
824
  ],
777
825
  "description": "An operational layer in a web map/scene."
778
826
  },
827
+ "PortalType": {
828
+ "description": "The type of Portal.",
829
+ "enum": [
830
+ "AGOL",
831
+ "ArcGISEnterprise"
832
+ ],
833
+ "type": "string"
834
+ },
779
835
  "PrintErrorEventArgs": {
780
836
  "additionalProperties": false,
781
837
  "description": "Arguments for the printing.print-error event.",
@@ -956,20 +1012,44 @@
956
1012
  ],
957
1013
  "type": "object"
958
1014
  },
1015
+ "SignInCompletedEventArgs": {
1016
+ "additionalProperties": false,
1017
+ "description": "Arguments for the auth.sign-in-completed and auth.portal-sign-in-completed events. Only available in VertiGIS Studio Mobile.",
1018
+ "properties": {
1019
+ "credential": {
1020
+ "$ref": "esriRuntimeSdk.Credential",
1021
+ "description": "The credential resulting from the sign in."
1022
+ },
1023
+ "identity": {
1024
+ "$ref": "#/definitions/ArcGISPortalIdentity",
1025
+ "description": "The identity that was obtained from the sign in."
1026
+ }
1027
+ },
1028
+ "required": [
1029
+ "credential",
1030
+ "identity"
1031
+ ],
1032
+ "type": "object"
1033
+ },
959
1034
  "SignInEventArgs": {
960
1035
  "additionalProperties": false,
961
- "description": "Arguments for the auth.sign-in events. Only available in the Geocortex Mobile Viewer.",
1036
+ "description": "Arguments for the auth.sign-in events. Only available in VertiGIS Studio Mobile.",
962
1037
  "properties": {
963
1038
  "authenticationType": {
964
1039
  "$ref": "#/definitions/AuthenticationType",
965
- "description": "The authentication method used for the sign in process. Not available in Geocortex Web Viewer."
1040
+ "description": "The authentication method used for the sign in process. Not available in VertiGIS Studio Web."
1041
+ },
1042
+ "portalType": {
1043
+ "$ref": "#/definitions/PortalType",
1044
+ "description": "The type of Portal: AGOL or Enterprise."
966
1045
  },
967
1046
  "requestInfo": {
968
- "description": "Information about the resource that is required to sign in. Not available in Geocortex Web Viewer. Will be an instance of esri.security.CredentialRequestInfo for the Geocortex Mobile Viewer."
1047
+ "description": "Information about the resource that is required to sign in. Not available in VertiGIS Studio Web. Will be an instance of esri.security.CredentialRequestInfo for VertiGIS Studio Mobile."
969
1048
  }
970
1049
  },
971
1050
  "required": [
972
1051
  "authenticationType",
1052
+ "portalType",
973
1053
  "requestInfo"
974
1054
  ],
975
1055
  "type": "object"
@@ -980,22 +1060,31 @@
980
1060
  "properties": {
981
1061
  "authenticationType": {
982
1062
  "$ref": "#/definitions/AuthenticationType",
983
- "description": "The authentication method used for the sign in process. Not available in Geocortex Web Viewer."
1063
+ "description": "The authentication method used for the sign in process. Not available in VertiGIS Studio Web."
984
1064
  },
985
1065
  "exception": {
986
- "description": "The exception that occurred during the sign in. Not available in Geocortex Web Viewer."
1066
+ "description": "The exception that occurred during the sign in. Not available in VertiGIS Studio Web."
1067
+ },
1068
+ "portalType": {
1069
+ "$ref": "#/definitions/PortalType",
1070
+ "description": "The type of Portal: AGOL or Enterprise."
987
1071
  },
988
1072
  "requestInfo": {
989
- "description": "Information about the resource that is required to sign in. Not available in Geocortex Web Viewer. Will be an instance of esri.security.CredentialRequestInfo for the Geocortex Mobile Viewer."
1073
+ "description": "Information about the resource that is required to sign in. Not available in VertiGIS Studio Web. Will be an instance of esri.security.CredentialRequestInfo for VertiGIS Studio Mobile."
990
1074
  }
991
1075
  },
992
1076
  "required": [
993
1077
  "authenticationType",
994
1078
  "exception",
1079
+ "portalType",
995
1080
  "requestInfo"
996
1081
  ],
997
1082
  "type": "object"
998
1083
  },
1084
+ "TimeSpan": {
1085
+ "additionalProperties": false,
1086
+ "type": "object"
1087
+ },
999
1088
  "UpdateSessionArgs": {
1000
1089
  "additionalProperties": false,
1001
1090
  "description": "Used to update an in-progress interactive feature editing session with new attributes, attachments or geometry. Web only.",
@@ -1021,6 +1110,10 @@
1021
1110
  "additionalProperties": false,
1022
1111
  "description": "Arguments for the ViewModeChanged event.",
1023
1112
  "properties": {
1113
+ "mapExtension": {
1114
+ "$ref": "@vertigis.arcgis-extensions.mapping.MapExtension.MapExtension",
1115
+ "description": "The map extension for which the event was generated."
1116
+ },
1024
1117
  "maps": {
1025
1118
  "$ref": "MapsLike",
1026
1119
  "description": "The map from which the event was generated."
@@ -1030,6 +1123,9 @@
1030
1123
  "description": "The new ViewMode."
1031
1124
  }
1032
1125
  },
1126
+ "required": [
1127
+ "mapExtension"
1128
+ ],
1033
1129
  "type": "object"
1034
1130
  },
1035
1131
  "VisualState": {
@@ -1111,13 +1207,20 @@
1111
1207
  "type": "object"
1112
1208
  },
1113
1209
  "auth.sign-in-completed": {
1114
- "description": "Raised when successfully signed in.",
1210
+ "description": "Raised when successfully signed in. Principal event type used in Web, SignInCompletedEventArgs used in Mobile.",
1115
1211
  "enum": [
1116
1212
  "auth.sign-in-completed"
1117
1213
  ]
1118
1214
  },
1119
1215
  "auth.sign-in-completed:input": {
1120
- "$ref": "Principal"
1216
+ "anyOf": [
1217
+ {
1218
+ "$ref": "Principal"
1219
+ },
1220
+ {
1221
+ "$ref": "#/definitions/SignInCompletedEventArgs"
1222
+ }
1223
+ ]
1121
1224
  },
1122
1225
  "auth.sign-in-failed": {
1123
1226
  "description": "Raised when a sign-in attempt fails.",
@@ -1164,7 +1267,7 @@
1164
1267
  ]
1165
1268
  },
1166
1269
  "auth.token-refreshed": {
1167
- "description": "Raised when the user's token is refreshed. Will be the new token in the Geocortex Web Viewer, and a TokenCredential object in the Geocortex Mobile Viewer.",
1270
+ "description": "Raised when the user's token is refreshed. Will be the new token in the VertiGIS Studio Web, and a TokenCredential object in VertiGIS Studio Mobile.",
1168
1271
  "enum": [
1169
1272
  "auth.token-refreshed"
1170
1273
  ]
@@ -9828,13 +9931,20 @@
9828
9931
  "$ref": "#/definitions/LocationMarkerEvent"
9829
9932
  },
9830
9933
  "map.initialized": {
9831
- "description": "Raised when a map has completed initialization.",
9934
+ "description": "Raised when a map has completed initialization. MapEvent used in Web, MapInitializedEvent used in Mobile.",
9832
9935
  "enum": [
9833
9936
  "map.initialized"
9834
9937
  ]
9835
9938
  },
9836
9939
  "map.initialized:input": {
9837
- "$ref": "MapEvent"
9940
+ "anyOf": [
9941
+ {
9942
+ "$ref": "MapEvent"
9943
+ },
9944
+ {
9945
+ "$ref": "MapInitializedEvent"
9946
+ }
9947
+ ]
9838
9948
  },
9839
9949
  "map.view-mode-changed": {
9840
9950
  "description": "Raised when a map's {@link ViewMode} is changed. This happens when the map view is changed between a WebMap and a WebScene.",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vertigis/viewer-spec",
3
- "version": "49.9.0",
3
+ "version": "50.0.0",
4
4
  "license": "SEE LICENSE IN LICENSE",
5
5
  "description": "VertiGIS Viewer Specification",
6
6
  "type": "module",
package/version.d.ts CHANGED
@@ -1,4 +1,4 @@
1
1
  /**
2
2
  * The current version of the Geocortex Viewer Specification.
3
3
  */
4
- export declare const version = "49.9.0";
4
+ export declare const version = "50.0.0";
package/version.js CHANGED
@@ -1,4 +1,4 @@
1
1
  /**
2
2
  * The current version of the Geocortex Viewer Specification.
3
3
  */
4
- export const version = "49.9.0";
4
+ export const version = "50.0.0";