@vertigis/viewer-spec 51.3.0 → 51.5.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.
@@ -1,6 +1,6 @@
1
1
  import type Color from "@arcgis/core/Color";
2
2
  import type { LayerExtension } from "@vertigis/arcgis-extensions/mapping/LayerExtension";
3
- import type { SublayerExtension } from "@vertigis/arcgis-extensions/mapping/_SublayerExtension";
3
+ import type { SublayerExtension } from "@vertigis/arcgis-extensions/mapping/SublayerExtension";
4
4
  /**
5
5
  * Well known connection points for Snapping.
6
6
  */
@@ -17,11 +17,12 @@ import type { FeatureList } from "@vertigis/arcgis-extensions/data/FeatureList";
17
17
  import type { FeatureSet } from "@vertigis/arcgis-extensions/data/FeatureSet";
18
18
  import type { FeatureSource } from "@vertigis/arcgis-extensions/data/FeatureSource";
19
19
  import type { FeatureStream } from "@vertigis/arcgis-extensions/data/FeatureStream";
20
+ import type { TableExtension, TableReference as TableReferenceObject } from "@vertigis/arcgis-extensions/data/TableExtension";
20
21
  import type { BasemapExtension } from "@vertigis/arcgis-extensions/mapping/BasemapExtension";
21
22
  import type { Bookmark, BookmarkProperties } from "@vertigis/arcgis-extensions/mapping/Bookmark";
23
+ import type { LayerExtension, LayerReference as LayerReferenceObject } from "@vertigis/arcgis-extensions/mapping/LayerExtension";
22
24
  import type { MapExtension } from "@vertigis/arcgis-extensions/mapping/MapExtension";
23
25
  import type { SublayerExtension } from "@vertigis/arcgis-extensions/mapping/SublayerExtension";
24
- import type { LayerExtension, LayerReference as LayerReferenceObject } from "@vertigis/arcgis-extensions/mapping/_LayerExtension";
25
26
  import type { Feature as GraphicJson } from "@vertigis/arcgis-extensions/portal/Feature";
26
27
  import type { Geometry as GeometryJson } from "@vertigis/arcgis-extensions/portal/Geometry";
27
28
  import type { LineSymbol3D as LineSymbol3DProperties } from "@vertigis/arcgis-extensions/portal/LineSymbol3D";
@@ -152,10 +153,15 @@ export declare type Maps = MapsLike | HasMaps;
152
153
  * both).
153
154
  */
154
155
  export declare type LayerReference = string | LayerReferenceObject;
156
+ /**
157
+ * A reference to an existing table, which is the ID or title of the table (or
158
+ * both).
159
+ */
160
+ export declare type TableReference = string | TableReferenceObject;
155
161
  /**
156
162
  * A (sub)layer extension, or an object that is convertible to one.
157
163
  */
158
- export declare type LayerLike = Layer | LayerExtension | SublayerLike | SublayerExtension | LayerReference;
164
+ export declare type LayerLike = Layer | LayerExtension | SublayerLike | SublayerExtension | LayerReference | TableExtension | TableReference;
159
165
  /**
160
166
  * One or more objects that are convertible to layer extensions.
161
167
  */
@@ -1,11 +1,11 @@
1
1
  import type { ItemRef } from "app-config/common/ItemRef.js";
2
2
  import type { Operation } from "../Operation.js";
3
3
  import { OperationRegistry } from "../OperationRegistry.js";
4
- import type { Model } from "../common.js";
4
+ import type { HasFeatures, HasLayers, HasMaps, Model } from "../common.js";
5
5
  /**
6
6
  * The arguments for the arcade.run operation.
7
7
  */
8
- export interface RunArcadeArgs {
8
+ export interface RunArcadeArgs extends HasMaps, HasLayers, HasFeatures {
9
9
  /**
10
10
  * The stringified Arcade script to run. If this property is included, the
11
11
  * operation will return the result of the script.
@@ -15,14 +15,18 @@ export interface RunArcadeArgs {
15
15
  * The stringified Arcade script used to determine whether or not the
16
16
  * executeScript can/should be run. If no executeScript is provided and the
17
17
  * canExecuteScript returns a truthy value, the operation will return its
18
- * input arguments; otherwise, if the canEecuteScript returns a falsey
18
+ * input arguments; otherwise, if the canExecuteScript returns a falsey
19
19
  * value, it will throw a {@link Cancellation}.
20
20
  */
21
21
  canExecuteScript?: string;
22
22
  /**
23
23
  * An arguments object that provides named variables and associated values,
24
24
  * which can be referenced from within the executeScript and
25
- * canExecuteScript.
25
+ * canExecuteScript. Note that context variables will be passed in if
26
+ * available under the well known arcade variable names: $feature,
27
+ * $features, $map, and $layer and $featuremap a constructed arcade
28
+ * dictionary that exposes a feature mapping dictionary keyed via feature
29
+ * source ID with the following values: id, title and features.
26
30
  *
27
31
  * NOTE: All variable keys must consist of only lowercase letters;
28
32
  * camel-cased context variables will break the script when they are
@@ -53,7 +57,7 @@ export interface ItemPropertyPath {
53
57
  export declare class ArcadeOperations extends OperationRegistry {
54
58
  /**
55
59
  * Runs a stringified Arcade script. If only a string is passed in as an
56
- * argument, it is interpreted as an executeScript. If an executeSript is
60
+ * argument, it is interpreted as an executeScript. If an executeScript is
57
61
  * provided, the operation will return its result. If only a canExecute
58
62
  * script is provided and it returns a truthy result, the operation will
59
63
  * return its input arguments. If a canExecuteScript returns a falsey value,
@@ -147,8 +147,9 @@ export interface UpdateSessionArgs extends HasGeometry {
147
147
  attachments?: Attachment[];
148
148
  }
149
149
  /**
150
- * Arguments for the "edit.create-feature" operation. A valid feature layer is
151
- * required. The geometry is required for non-tabular features. Web only.
150
+ * Arguments for the "edit.create-feature" operation. A valid feature layer,
151
+ * subtype group layer, or subtype sublayer is required. The geometry is
152
+ * required for non-tabular features. Web only.
152
153
  */
153
154
  export interface CreateFeatureArgs extends HasGeometry, HasLayers, HasMaps, EditUIOptions {
154
155
  /**
@@ -423,6 +423,21 @@
423
423
  },
424
424
  "type": "object"
425
425
  },
426
+ "@vertigis.arcgis-extensions.data._TableExtension.TableReference": {
427
+ "additionalProperties": false,
428
+ "description": "Matches an existing table in a map.",
429
+ "properties": {
430
+ "id": {
431
+ "description": "The table's ID.",
432
+ "type": "string"
433
+ },
434
+ "title": {
435
+ "description": "The table's title.",
436
+ "type": "string"
437
+ }
438
+ },
439
+ "type": "object"
440
+ },
426
441
  "@vertigis.arcgis-extensions.mapping.Bookmark.BookmarkProperties": {
427
442
  "additionalProperties": false,
428
443
  "description": "Properties that can be passed into the constructor for{@linkmapping /Bookmark!Bookmark}.",
@@ -1833,6 +1848,9 @@
1833
1848
  {
1834
1849
  "$ref": "#/definitions/@vertigis.arcgis-extensions.mapping._LayerExtension.LayerReference"
1835
1850
  },
1851
+ {
1852
+ "$ref": "#/definitions/@vertigis.arcgis-extensions.data._TableExtension.TableReference"
1853
+ },
1836
1854
  {
1837
1855
  "$ref": "#/definitions/esri.Layer"
1838
1856
  },
@@ -1845,12 +1863,18 @@
1845
1863
  {
1846
1864
  "$ref": "@vertigis.arcgis-extensions.mapping._SublayerExtension.SublayerExtension"
1847
1865
  },
1866
+ {
1867
+ "$ref": "@vertigis.arcgis-extensions.data._TableExtension.TableExtension"
1868
+ },
1848
1869
  {
1849
1870
  "items": {
1850
1871
  "anyOf": [
1851
1872
  {
1852
1873
  "$ref": "#/definitions/@vertigis.arcgis-extensions.mapping._LayerExtension.LayerReference"
1853
1874
  },
1875
+ {
1876
+ "$ref": "#/definitions/@vertigis.arcgis-extensions.data._TableExtension.TableReference"
1877
+ },
1854
1878
  {
1855
1879
  "$ref": "#/definitions/esri.Layer"
1856
1880
  },
@@ -1863,6 +1887,9 @@
1863
1887
  {
1864
1888
  "$ref": "@vertigis.arcgis-extensions.mapping._SublayerExtension.SublayerExtension"
1865
1889
  },
1890
+ {
1891
+ "$ref": "@vertigis.arcgis-extensions.data._TableExtension.TableExtension"
1892
+ },
1866
1893
  {
1867
1894
  "type": "string"
1868
1895
  }
@@ -423,6 +423,21 @@
423
423
  },
424
424
  "type": "object"
425
425
  },
426
+ "@vertigis.arcgis-extensions.data._TableExtension.TableReference": {
427
+ "additionalProperties": false,
428
+ "description": "Matches an existing table in a map.",
429
+ "properties": {
430
+ "id": {
431
+ "description": "The table's ID.",
432
+ "type": "string"
433
+ },
434
+ "title": {
435
+ "description": "The table's title.",
436
+ "type": "string"
437
+ }
438
+ },
439
+ "type": "object"
440
+ },
426
441
  "@vertigis.arcgis-extensions.mapping._LayerExtension.LayerReference": {
427
442
  "additionalProperties": false,
428
443
  "description": "Matches an existing layer.",
@@ -2337,6 +2352,9 @@
2337
2352
  {
2338
2353
  "$ref": "#/definitions/@vertigis.arcgis-extensions.mapping._LayerExtension.LayerReference"
2339
2354
  },
2355
+ {
2356
+ "$ref": "#/definitions/@vertigis.arcgis-extensions.data._TableExtension.TableReference"
2357
+ },
2340
2358
  {
2341
2359
  "$ref": "#/definitions/esri.Layer"
2342
2360
  },
@@ -2349,12 +2367,18 @@
2349
2367
  {
2350
2368
  "$ref": "@vertigis.arcgis-extensions.mapping._SublayerExtension.SublayerExtension"
2351
2369
  },
2370
+ {
2371
+ "$ref": "@vertigis.arcgis-extensions.data._TableExtension.TableExtension"
2372
+ },
2352
2373
  {
2353
2374
  "items": {
2354
2375
  "anyOf": [
2355
2376
  {
2356
2377
  "$ref": "#/definitions/@vertigis.arcgis-extensions.mapping._LayerExtension.LayerReference"
2357
2378
  },
2379
+ {
2380
+ "$ref": "#/definitions/@vertigis.arcgis-extensions.data._TableExtension.TableReference"
2381
+ },
2358
2382
  {
2359
2383
  "$ref": "#/definitions/esri.Layer"
2360
2384
  },
@@ -2367,6 +2391,9 @@
2367
2391
  {
2368
2392
  "$ref": "@vertigis.arcgis-extensions.mapping._SublayerExtension.SublayerExtension"
2369
2393
  },
2394
+ {
2395
+ "$ref": "@vertigis.arcgis-extensions.data._TableExtension.TableExtension"
2396
+ },
2370
2397
  {
2371
2398
  "type": "string"
2372
2399
  }
@@ -423,6 +423,21 @@
423
423
  },
424
424
  "type": "object"
425
425
  },
426
+ "@vertigis.arcgis-extensions.data._TableExtension.TableReference": {
427
+ "additionalProperties": false,
428
+ "description": "Matches an existing table in a map.",
429
+ "properties": {
430
+ "id": {
431
+ "description": "The table's ID.",
432
+ "type": "string"
433
+ },
434
+ "title": {
435
+ "description": "The table's title.",
436
+ "type": "string"
437
+ }
438
+ },
439
+ "type": "object"
440
+ },
426
441
  "@vertigis.arcgis-extensions.mapping.Bookmark.BookmarkProperties": {
427
442
  "additionalProperties": false,
428
443
  "description": "Properties that can be passed into the constructor for{@linkmapping /Bookmark!Bookmark}.",
@@ -1364,7 +1379,7 @@
1364
1379
  },
1365
1380
  "CreateFeatureArgs": {
1366
1381
  "additionalProperties": false,
1367
- "description": "Arguments for the \"edit.create-feature\" operation. A valid feature layer is required. The geometry is required for non-tabular features. Web only.",
1382
+ "description": "Arguments for the \"edit.create-feature\" operation. A valid feature layer, subtype group layer, or subtype sublayer is required. The geometry is required for non-tabular features. Web only.",
1368
1383
  "properties": {
1369
1384
  "featureAttributes": {
1370
1385
  "description": "A collection of attributes to apply to the new feature."
@@ -3497,6 +3512,9 @@
3497
3512
  {
3498
3513
  "$ref": "#/definitions/@vertigis.arcgis-extensions.mapping._LayerExtension.LayerReference"
3499
3514
  },
3515
+ {
3516
+ "$ref": "#/definitions/@vertigis.arcgis-extensions.data._TableExtension.TableReference"
3517
+ },
3500
3518
  {
3501
3519
  "$ref": "#/definitions/esri.Layer"
3502
3520
  },
@@ -3509,12 +3527,18 @@
3509
3527
  {
3510
3528
  "$ref": "@vertigis.arcgis-extensions.mapping._SublayerExtension.SublayerExtension"
3511
3529
  },
3530
+ {
3531
+ "$ref": "@vertigis.arcgis-extensions.data._TableExtension.TableExtension"
3532
+ },
3512
3533
  {
3513
3534
  "items": {
3514
3535
  "anyOf": [
3515
3536
  {
3516
3537
  "$ref": "#/definitions/@vertigis.arcgis-extensions.mapping._LayerExtension.LayerReference"
3517
3538
  },
3539
+ {
3540
+ "$ref": "#/definitions/@vertigis.arcgis-extensions.data._TableExtension.TableReference"
3541
+ },
3518
3542
  {
3519
3543
  "$ref": "#/definitions/esri.Layer"
3520
3544
  },
@@ -3527,6 +3551,9 @@
3527
3551
  {
3528
3552
  "$ref": "@vertigis.arcgis-extensions.mapping._SublayerExtension.SublayerExtension"
3529
3553
  },
3554
+ {
3555
+ "$ref": "@vertigis.arcgis-extensions.data._TableExtension.TableExtension"
3556
+ },
3530
3557
  {
3531
3558
  "type": "string"
3532
3559
  }
@@ -3549,6 +3576,9 @@
3549
3576
  {
3550
3577
  "$ref": "#/definitions/@vertigis.arcgis-extensions.mapping._LayerExtension.LayerReference"
3551
3578
  },
3579
+ {
3580
+ "$ref": "#/definitions/@vertigis.arcgis-extensions.data._TableExtension.TableReference"
3581
+ },
3552
3582
  {
3553
3583
  "$ref": "#/definitions/esri.Layer"
3554
3584
  },
@@ -3561,12 +3591,18 @@
3561
3591
  {
3562
3592
  "$ref": "@vertigis.arcgis-extensions.mapping._SublayerExtension.SublayerExtension"
3563
3593
  },
3594
+ {
3595
+ "$ref": "@vertigis.arcgis-extensions.data._TableExtension.TableExtension"
3596
+ },
3564
3597
  {
3565
3598
  "items": {
3566
3599
  "anyOf": [
3567
3600
  {
3568
3601
  "$ref": "#/definitions/@vertigis.arcgis-extensions.mapping._LayerExtension.LayerReference"
3569
3602
  },
3603
+ {
3604
+ "$ref": "#/definitions/@vertigis.arcgis-extensions.data._TableExtension.TableReference"
3605
+ },
3570
3606
  {
3571
3607
  "$ref": "#/definitions/esri.Layer"
3572
3608
  },
@@ -3579,6 +3615,9 @@
3579
3615
  {
3580
3616
  "$ref": "@vertigis.arcgis-extensions.mapping._SublayerExtension.SublayerExtension"
3581
3617
  },
3618
+ {
3619
+ "$ref": "@vertigis.arcgis-extensions.data._TableExtension.TableExtension"
3620
+ },
3582
3621
  {
3583
3622
  "type": "string"
3584
3623
  }
@@ -4249,16 +4288,28 @@
4249
4288
  "description": "The arguments for the arcade.run operation.",
4250
4289
  "properties": {
4251
4290
  "arguments": {
4252
- "description": "An arguments object that provides named variables and associated values, which can be referenced from within the executeScript and canExecuteScript. NOTE: All variable keys must consist of only lowercase letters; camel-cased context variables will break the script when they are referenced at runtime."
4291
+ "description": "An arguments object that provides named variables and associated values, which can be referenced from within the executeScript and canExecuteScript. Note that context variables will be passed in if available under the well known arcade variable names: $feature, $features, $map, and $layer and $featuremap a constructed arcade dictionary that exposes a feature mapping dictionary keyed via feature source ID with the following values: id, title and features. NOTE: All variable keys must consist of only lowercase letters; camel-cased context variables will break the script when they are referenced at runtime."
4253
4292
  },
4254
4293
  "canExecuteScript": {
4255
- "description": "The stringified Arcade script used to determine whether or not the executeScript can/should be run. If no executeScript is provided and the canExecuteScript returns a truthy value, the operation will return its input arguments; otherwise, if the canEecuteScript returns a falsey value, it will throw a{@linkCancellation}.",
4294
+ "description": "The stringified Arcade script used to determine whether or not the executeScript can/should be run. If no executeScript is provided and the canExecuteScript returns a truthy value, the operation will return its input arguments; otherwise, if the canExecuteScript returns a falsey value, it will throw a{@linkCancellation}.",
4256
4295
  "type": "string"
4257
4296
  },
4258
4297
  "executeScript": {
4259
4298
  "description": "The stringified Arcade script to run. If this property is included, the operation will return the result of the script.",
4260
4299
  "type": "string"
4261
4300
  },
4301
+ "features": {
4302
+ "$ref": "#/definitions/FeaturesLike",
4303
+ "description": "Features to use for the command/operation."
4304
+ },
4305
+ "layers": {
4306
+ "$ref": "#/definitions/LayersLike",
4307
+ "description": "Layer(s) to use for the command/operation."
4308
+ },
4309
+ "maps": {
4310
+ "$ref": "MapsLike",
4311
+ "description": "Map(s) to use for the command/operation."
4312
+ },
4262
4313
  "watchHandles": {
4263
4314
  "description": "Properties used to set a series of watch handles and/or event listeners on an item that will trigger the canExecuteChanged event for the 'arcade.run' operation.",
4264
4315
  "items": {
@@ -6026,7 +6077,7 @@
6026
6077
  ]
6027
6078
  },
6028
6079
  "arcade.run": {
6029
- "description": "Runs a stringified Arcade script. If only a string is passed in as an argument, it is interpreted as an executeScript. If an executeSript is provided, the operation will return its result. If only a canExecute script is provided and it returns a truthy result, the operation will return its input arguments. If a canExecuteScript returns a falsey value, the operation will throw a {@link Cancellation }.",
6080
+ "description": "Runs a stringified Arcade script. If only a string is passed in as an argument, it is interpreted as an executeScript. If an executeScript is provided, the operation will return its result. If only a canExecute script is provided and it returns a truthy result, the operation will return its input arguments. If a canExecuteScript returns a falsey value, the operation will throw a {@link Cancellation }.",
6030
6081
  "enum": [
6031
6082
  "arcade.run"
6032
6083
  ]
@@ -17039,6 +17090,9 @@
17039
17090
  {
17040
17091
  "$ref": "#/definitions/@vertigis.arcgis-extensions.mapping._LayerExtension.LayerReference"
17041
17092
  },
17093
+ {
17094
+ "$ref": "#/definitions/@vertigis.arcgis-extensions.data._TableExtension.TableReference"
17095
+ },
17042
17096
  {
17043
17097
  "$ref": "#/definitions/esri.Layer"
17044
17098
  },
@@ -17051,12 +17105,18 @@
17051
17105
  {
17052
17106
  "$ref": "@vertigis.arcgis-extensions.mapping._SublayerExtension.SublayerExtension"
17053
17107
  },
17108
+ {
17109
+ "$ref": "@vertigis.arcgis-extensions.data._TableExtension.TableExtension"
17110
+ },
17054
17111
  {
17055
17112
  "items": {
17056
17113
  "anyOf": [
17057
17114
  {
17058
17115
  "$ref": "#/definitions/@vertigis.arcgis-extensions.mapping._LayerExtension.LayerReference"
17059
17116
  },
17117
+ {
17118
+ "$ref": "#/definitions/@vertigis.arcgis-extensions.data._TableExtension.TableReference"
17119
+ },
17060
17120
  {
17061
17121
  "$ref": "#/definitions/esri.Layer"
17062
17122
  },
@@ -17069,6 +17129,9 @@
17069
17129
  {
17070
17130
  "$ref": "@vertigis.arcgis-extensions.mapping._SublayerExtension.SublayerExtension"
17071
17131
  },
17132
+ {
17133
+ "$ref": "@vertigis.arcgis-extensions.data._TableExtension.TableExtension"
17134
+ },
17072
17135
  {
17073
17136
  "type": "string"
17074
17137
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vertigis/viewer-spec",
3
- "version": "51.3.0",
3
+ "version": "51.5.0",
4
4
  "license": "SEE LICENSE IN LICENSE",
5
5
  "description": "VertiGIS Viewer Specification",
6
6
  "type": "module",
@@ -35,16 +35,16 @@
35
35
  },
36
36
  "author": "VertiGIS Ltd.",
37
37
  "peerDependencies": {
38
- "@vertigis/arcgis-extensions": ">= 37.3.0 < 38.0.0"
38
+ "@vertigis/arcgis-extensions": ">= 37.5.0 < 38.0.0"
39
39
  },
40
40
  "devDependencies": {
41
- "@arcgis/core": "4.24.7",
41
+ "@arcgis/core": "^4.25.5",
42
42
  "@prettier/plugin-xml": "2.2.0",
43
43
  "@types/glob": "8.0.0",
44
44
  "@types/node": "14.14.41",
45
45
  "@typescript-eslint/eslint-plugin": "5.42.1",
46
46
  "@typescript-eslint/parser": "5.42.1",
47
- "@vertigis/arcgis-extensions": "37.3.0",
47
+ "@vertigis/arcgis-extensions": "37.5.0",
48
48
  "del-cli": "5.0.0",
49
49
  "eslint": "8.27.0",
50
50
  "eslint-config-prettier": "8.5.0",
package/version.d.ts CHANGED
@@ -1,4 +1,4 @@
1
1
  /**
2
2
  * The current version of the VertiGIS Studio Viewer Specification.
3
3
  */
4
- export declare const version = "51.3.0";
4
+ export declare const version = "51.5.0";
package/version.js CHANGED
@@ -1,4 +1,4 @@
1
1
  /**
2
2
  * The current version of the VertiGIS Studio Viewer Specification.
3
3
  */
4
- export const version = "51.3.0";
4
+ export const version = "51.5.0";