@vertigis/viewer-spec 47.5.0 → 48.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 (67) hide show
  1. package/app-config/AppConfig.d.ts +3 -6
  2. package/app-config/common/AnalyticsModelProperties.d.ts +10 -0
  3. package/app-config/common/AnalyticsModelProperties.js +1 -0
  4. package/app-config/common/BrandingThemeProperties.d.ts +2 -4
  5. package/app-config/common/HighlightModelProperties.d.ts +2 -4
  6. package/app-config/common/LayerPresetsModelProperties.d.ts +1 -2
  7. package/app-config/common/LayoutProperties.d.ts +3 -3
  8. package/app-config/common/RegionModelProperties.d.ts +1 -2
  9. package/app-config/common/SearchModelProperties.d.ts +2 -2
  10. package/app-config/common/WorkflowModelProperties.d.ts +2 -4
  11. package/app-config/mobile/FeatureDetailsModelProperties.d.ts +2 -1
  12. package/app-config/mobile/SearchModelProperties.d.ts +3 -1
  13. package/app-config/mobile/VertigisMobileModelProperties.d.ts +17 -16
  14. package/app-config/schema/common-app-config.schema.json +1 -1
  15. package/app-config/schema/mobile-app-config.schema.json +1 -1
  16. package/app-config/schema/web-app-config.schema.json +1 -1
  17. package/app-config/web/DrawModelProperties.d.ts +1 -2
  18. package/app-config/web/FeatureDetailsModelProperties.d.ts +2 -2
  19. package/app-config/web/HasVisibilityFilters.d.ts +4 -4
  20. package/app-config/web/KpiCardModelProperties.d.ts +10 -10
  21. package/app-config/web/MapCoordinatesModelProperties.d.ts +1 -2
  22. package/app-config/web/MapModelProperties.d.ts +2 -4
  23. package/app-config/web/MeasurementModelProperties.d.ts +1 -2
  24. package/app-config/web/ResultsModelProperties.d.ts +2 -2
  25. package/app-config/web/SearchModelProperties.d.ts +1 -2
  26. package/app-config/web/VertigisWebModelProperties.d.ts +8 -10
  27. package/layout/schema/layout-common.xsd +843 -830
  28. package/layout/schema/layout-mobile.xsd +241 -234
  29. package/layout/schema/layout-web.xsd +281 -277
  30. package/layout/schema/schema-reference-example.xml +11 -10
  31. package/messaging/Command.d.ts +1 -2
  32. package/messaging/Event.d.ts +2 -4
  33. package/messaging/MessageBus.d.ts +2 -2
  34. package/messaging/Operation.d.ts +1 -2
  35. package/messaging/common.d.ts +9 -14
  36. package/messaging/registry/app.d.ts +6 -10
  37. package/messaging/registry/arcade.d.ts +3 -7
  38. package/messaging/registry/auth.d.ts +6 -10
  39. package/messaging/registry/basemap.d.ts +8 -8
  40. package/messaging/registry/charts.d.ts +2 -2
  41. package/messaging/registry/debugConsole.d.ts +3 -4
  42. package/messaging/registry/drawing.d.ts +3 -6
  43. package/messaging/registry/edit.d.ts +9 -14
  44. package/messaging/registry/geolocation.d.ts +13 -20
  45. package/messaging/registry/geometry.d.ts +26 -31
  46. package/messaging/registry/kpi.d.ts +2 -4
  47. package/messaging/registry/layer-comparison.d.ts +2 -2
  48. package/messaging/registry/layout.d.ts +1 -2
  49. package/messaging/registry/location-marker.d.ts +5 -10
  50. package/messaging/registry/map.d.ts +21 -22
  51. package/messaging/registry/measurement.d.ts +6 -8
  52. package/messaging/registry/messaging.d.ts +3 -3
  53. package/messaging/registry/offline.d.ts +19 -24
  54. package/messaging/registry/panel.d.ts +1 -2
  55. package/messaging/registry/portal.d.ts +1 -2
  56. package/messaging/registry/printing.d.ts +3 -4
  57. package/messaging/registry/results.d.ts +8 -16
  58. package/messaging/registry/sketching.d.ts +27 -40
  59. package/messaging/registry/system.d.ts +6 -6
  60. package/messaging/registry/tasks.d.ts +4 -6
  61. package/messaging/registry/ui.d.ts +12 -18
  62. package/messaging/registry/viewer.d.ts +1 -2
  63. package/messaging/registry/workflow.d.ts +2 -4
  64. package/messaging/schema/web-action.schema.json +1 -1
  65. package/package.json +17 -17
  66. package/version.d.ts +1 -1
  67. package/version.js +1 -1
@@ -79,8 +79,8 @@ export interface OpenUrlArgs {
79
79
  /**
80
80
  * The locale to use for number token substitution. Accepts a valid locale
81
81
  * code (example: "en", "fr" or "de-AT"), or "device" or "invariant" which
82
- * will use the device's current culture or the invariant culture, respectively.
83
- * Default is invariant culture.
82
+ * will use the device's current culture or the invariant culture,
83
+ * respectively. Default is invariant culture.
84
84
  */
85
85
  numberFormatterLocale?: string;
86
86
  }
@@ -140,13 +140,13 @@ export declare class SystemCommands extends CommandRegistry {
140
140
  * first map's view. In Web, if both layers and maps are included as
141
141
  * context, then {@link LayerToken} can be used to access properties on the
142
142
  * first layer.
143
- *
144
143
  */
145
144
  get openUrl(): Command<OpenUrlArgs | WebOpenUrlArgs | string>;
146
145
  /**
147
- * Allows to control if the screen should be kept on. Passing true as parameter
148
- * will keep the screen on, ignoring possible system settings for screen timeouts.
149
- * Passing false as parameter will make the app respect system settings again.
146
+ * Allows to control if the screen should be kept on. Passing true as
147
+ * parameter will keep the screen on, ignoring possible system settings for
148
+ * screen timeouts. Passing false as parameter will make the app respect
149
+ * system settings again.
150
150
  *
151
151
  * @mobileOnly
152
152
  */
@@ -41,21 +41,19 @@ export interface SearchArgs {
41
41
  */
42
42
  maxResults?: number;
43
43
  /**
44
- * The maximum number of results to query per source, the results
45
- * per source will still be limited by maxResults.
44
+ * The maximum number of results to query per source, the results per source
45
+ * will still be limited by maxResults.
46
46
  */
47
47
  maxQueryResults?: number;
48
48
  /**
49
- * If specified, results are limited to features that intersect the
50
- * geometry.
49
+ * If specified, results are limited to features that intersect the geometry.
51
50
  */
52
51
  searchArea?: Geometry;
53
52
  /**
54
53
  * If specified, this will influence the score of spatial features based on
55
54
  * their proximity to this point. Most commonly this would be the user's
56
55
  * current location, but can be any point of interest. This option requires
57
- * searchArea to also be specified. Not supported in Geocortex Mobile
58
- * Viewer.
56
+ * searchArea to also be specified. Not supported in Geocortex Mobile Viewer.
59
57
  */
60
58
  near?: Point;
61
59
  /**
@@ -86,18 +86,17 @@ export interface DisplayNotificationArgs {
86
86
  */
87
87
  position?: Position;
88
88
  /**
89
- * Disable notification timeouts. Timeouts only apply to "info" and "success"
90
- * categories. Web only.
89
+ * Disable notification timeouts. Timeouts only apply to "info" and
90
+ * "success" categories. Web only.
91
91
  */
92
92
  disableTimeouts?: boolean;
93
93
  /**
94
- * Notifications in the same notification group are mutually exclusive,
95
- * and will supersede one another. Mobile only.
94
+ * Notifications in the same notification group are mutually exclusive, and
95
+ * will supersede one another. Mobile only.
96
96
  */
97
97
  notificationGroup?: string;
98
98
  /**
99
- * The notification title - only shown for system notifications. Mobile
100
- * only.
99
+ * The notification title - only shown for system notifications. Mobile only.
101
100
  */
102
101
  title?: string;
103
102
  /**
@@ -107,8 +106,7 @@ export interface DisplayNotificationArgs {
107
106
  type?: NotificationType;
108
107
  }
109
108
  /**
110
- * The type of notification - 'app', 'system', or 'auto'. Defaults to 'auto'.
111
- * Mobile only.
109
+ * The type of notification - 'app', 'system', or 'auto'. Defaults to 'auto'. Mobile only.
112
110
  */
113
111
  export declare enum NotificationType {
114
112
  /**
@@ -246,8 +244,7 @@ export declare class UICommands extends CommandRegistry {
246
244
  */
247
245
  get deactivate(): Command<ComponentId | Model>;
248
246
  /**
249
- * Displays a spinner and custom message to the user to indicate that the UI
250
- * is busy.
247
+ * Displays a spinner and custom message to the user to indicate that the UI is busy.
251
248
  *
252
249
  * @mobileOnly
253
250
  */
@@ -285,8 +282,8 @@ export declare class UICommands extends CommandRegistry {
285
282
  */
286
283
  get hideNotification(): Command;
287
284
  /**
288
- * Forces assistive technology (screen readers) to narrate a
289
- * translatable message to the end user.
285
+ * Forces assistive technology (screen readers) to narrate a translatable
286
+ * message to the end user.
290
287
  *
291
288
  * @webOnly
292
289
  */
@@ -305,8 +302,7 @@ export declare class UICommands extends CommandRegistry {
305
302
  */
306
303
  get setLocale(): Command<string>;
307
304
  /**
308
- * Sets the color theme of the viewer. The required argument is the new
309
- * theme's ID.
305
+ * Sets the color theme of the viewer. The required argument is the new theme's ID.
310
306
  */
311
307
  get setTheme(): Command<string>;
312
308
  /**
@@ -382,15 +378,13 @@ export declare class UIEvents extends EventRegistry {
382
378
  */
383
379
  get densityChanged(): Event<UIDensity>;
384
380
  /**
385
- * Raised when the locale is changed by the user. The argument is the locale
386
- * code.
381
+ * Raised when the locale is changed by the user. The argument is the locale code.
387
382
  *
388
383
  * @webOnly
389
384
  */
390
385
  get localeChanged(): Event<string>;
391
386
  /**
392
- * Raised when a component begins initialization. The argument is the
393
- * component ID.
387
+ * Raised when a component begins initialization. The argument is the component ID.
394
388
  *
395
389
  * @webOnly
396
390
  */
@@ -7,8 +7,7 @@ import { OperationRegistry } from "../OperationRegistry.js";
7
7
  import type { Model } from "../common.js";
8
8
  export declare class ViewerCommands extends CommandRegistry {
9
9
  /**
10
- * Loads a new layout. Can be a layout URL or layout XML, or a Layout
11
- * object.
10
+ * Loads a new layout. Can be a layout URL or layout XML, or a Layout object.
12
11
  *
13
12
  * @webOnly
14
13
  */
@@ -34,8 +34,7 @@ export interface RunWorkflowArgs {
34
34
  */
35
35
  instanceId?: string;
36
36
  /**
37
- * The map to target, if omitted Web will attempt to choose the best map for
38
- * you.
37
+ * The map to target, if omitted Web will attempt to choose the best map for you.
39
38
  *
40
39
  * @webOnly
41
40
  */
@@ -44,8 +43,7 @@ export interface RunWorkflowArgs {
44
43
  * The layout ID of the workflow component to use for any workflow forms, or
45
44
  * the ID of a container component like taskbar, panel, stack, etc. In the
46
45
  * latter case, a new workflow component will be created dynamically as a
47
- * child of the targeted container, and removed when the workflow finishes
48
- * running.
46
+ * child of the targeted container, and removed when the workflow finishes running.
49
47
  */
50
48
  target?: string;
51
49
  /**
@@ -16237,7 +16237,7 @@
16237
16237
  ]
16238
16238
  },
16239
16239
  "messaging.mix-in-args": {
16240
- "description": "Attempts to merge an array of values into a single value that can be used as an argument for a command or operation. For example: ``` [features, { chart: \"average-household-income\" }] ``` This would mix `features` obtained from some other source into arguments intended for the \"charts.display\" command. If the values cannot be merged, then the leftmost value is returned. Note that argument merging already occurs automatically in command chains; this explicit operation exists for advanced scenarios like Geocortex Workflow or custom code written using the SDK.",
16240
+ "description": "Attempts to merge an array of values into a single value that can be used as an argument for a command or operation. For example: [features, { chart: \"average-household-income\" }]; This would mix `features` obtained from some other source into arguments intended for the \"charts.display\" command. If the values cannot be merged, then the leftmost value is returned. Note that argument merging already occurs automatically in command chains; this explicit operation exists for advanced scenarios like Geocortex Workflow or custom code written using the SDK.",
16241
16241
  "enum": [
16242
16242
  "messaging.mix-in-args"
16243
16243
  ]
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vertigis/viewer-spec",
3
- "version": "47.5.0",
3
+ "version": "48.0.0",
4
4
  "license": "SEE LICENSE IN LICENSE",
5
5
  "description": "VertiGIS Viewer Specification",
6
6
  "type": "module",
@@ -14,16 +14,15 @@
14
14
  ],
15
15
  "scripts": {
16
16
  "app-schema": "npm run -s prepare && node build/js/appConfigSchema.js",
17
- "build": "npm run -s delete-js-folders && npm run update-version && tsc -d -p src && npm run minify && npm run -s lint && npm run -s build-schema && npm run -s copy-layout-files",
18
- "build-debug": "npm run -s delete-js-folders && npm run update-version && tsc -d --sourceMap true -p src && npm run -s lint && npm run build-schema && npm run -s copy-layout-files",
17
+ "build": "npm run -s delete-js-folders && npm run update-version && tsc -d -p src && npm run minify && npm run -s lint && npm run -s build-schema",
18
+ "build-debug": "npm run -s delete-js-folders && npm run update-version && tsc -d --sourceMap true -p src && npm run -s lint && npm run build-schema",
19
19
  "build-schema": "node build/js/appConfigSchema.js && node build/js/messageSchema.js",
20
- "copy-layout-files": "cpy layout/schema/layout*.xsd layout/schema",
21
20
  "delete-js-folders": "del-cli app-config messaging",
22
21
  "lint": "eslint . --max-warnings=0",
23
22
  "message-schema": "npm run -s prepare && node build/js/messageSchema.js",
24
23
  "minify": "node build/js/minify.js",
25
24
  "prepare": "del-cli build/js && tsc -p build",
26
- "prettier": "prettier --write \"**/*.ts\" \"**/*.json\" \"**/*.js\"",
25
+ "prettier": "prettier --write \"**/*.ts\" \"**/*.json\" \"**/*.js\" \"**/*.xml\" \"**/*.xsd\"",
27
26
  "start": "tsc -w -p src",
28
27
  "update-version": "node build/js/generateVersion.js",
29
28
  "watch-build-folder": "tsc -p build -w"
@@ -38,34 +37,35 @@
38
37
  },
39
38
  "devDependencies": {
40
39
  "@arcgis/core": "4.23.3",
41
- "@vertigis/arcgis-extensions": "35.0.0",
40
+ "@prettier/plugin-xml": "2.2.0",
42
41
  "@types/glob": "7.2.0",
43
42
  "@types/node": "14.14.41",
44
- "@typescript-eslint/eslint-plugin": " 5.18.0",
45
- "@typescript-eslint/parser": " 5.18.0",
46
- "cpy-cli": "3.1.1",
43
+ "@typescript-eslint/eslint-plugin": "5.23.0",
44
+ "@typescript-eslint/parser": "5.23.0",
45
+ "@vertigis/arcgis-extensions": "35.0.0",
47
46
  "del-cli": "4.0.1",
48
- "eslint": "8.12.0",
47
+ "eslint": "8.15.0",
49
48
  "eslint-config-prettier": "8.5.0",
50
- "eslint-plugin-import": "2.25.4",
51
- "eslint-plugin-jsdoc": "38.1.6",
49
+ "eslint-plugin-import": "2.26.0",
50
+ "eslint-plugin-jsdoc": "39.2.9",
52
51
  "eslint-plugin-no-autofix": "1.2.3",
53
52
  "eslint-plugin-only-warn": "1.0.3",
54
- "glob": "7.2.0",
53
+ "glob": "8.0.2",
55
54
  "highcharts": "10.0.0",
56
55
  "safe-stable-stringify": "2.3.1",
57
- "lint-staged": "12.3.7",
56
+ "lint-staged": "12.4.1",
58
57
  "path-equal": "1.1.3",
59
58
  "prettier": "2.6.2",
59
+ "prettier-plugin-jsdoc": "0.3.38",
60
60
  "simple-git-hooks": "2.7.0",
61
- "terser": "5.12.1",
62
- "typescript": "4.6.3",
61
+ "terser": "5.13.1",
62
+ "typescript": "4.6.4",
63
63
  "weaktuplemap": "1.0.0"
64
64
  },
65
65
  "simple-git-hooks": {
66
66
  "pre-commit": "npx lint-staged"
67
67
  },
68
68
  "lint-staged": {
69
- "*.{js,json,ts,md}": "prettier --write"
69
+ "*.{js,json,ts,md,xml,xsd}": "prettier --write"
70
70
  }
71
71
  }
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 = "47.5.0";
4
+ export declare const version = "48.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 = "47.5.0";
4
+ export const version = "48.0.0";