@vertigis/viewer-spec 56.15.0 → 56.17.0

package/app-config/web/PrintModelProperties.d.ts

@@ -0,0 +1,11 @@
+import type { ModelProperties } from "../common/ModelProperties.js";
+/**
+ * Configuration for the printing service.
+ */
+export interface PrintModelProperties extends ModelProperties {
+    /**
+     * The URL for the external printing service that's used to print maps
+     * alongside ArcGIS pro layouts.
+     */
+    printServiceUrl?: string;
+}

package/app-config/web/PrintModelProperties.js

@@ -0,0 +1 @@
+export{};

package/messaging/registry/tasks.d.ts

@@ -3,12 +3,59 @@ import type Geometry from "@arcgis/core/geometry/Geometry";
 import type Point from "@arcgis/core/geometry/Point";
 import type SpatialReference from "@arcgis/core/geometry/SpatialReference";
 import type { FeatureSource } from "@vertigis/arcgis-extensions/data/FeatureSource";
+import type { GeometryJsonType } from "@vertigis/arcgis-extensions/json/GeometryJson.js";
 import type { IdentifyOptions } from "@vertigis/arcgis-extensions/tasks/identify/IdentifyOptions";
 import type { Event } from "../Event.js";
 import { EventRegistry } from "../EventRegistry.js";
 import type { Operation } from "../Operation.js";
 import { OperationRegistry } from "../OperationRegistry.js";
-import type { Features, GeometryLike, MapsFeatureResultArgs, MapsLike } from "../common.js";
+import type { Features, GeometryLike, LayerLike, MapsFeatureResultArgs, MapsLike } from "../common.js";
+interface FilterSourcesBaseArgs {
+    /**
+     * The map from which to retrieve the sources. This argument will not be
+     * forwarded in the result of this operation.
+     */
+    maps?: MapsLike;
+    /**
+     * The sources to search in. This can be used in combination with the "maps"
+     * argument to search both.
+     */
+    sources?: FeatureSource[];
+}
+interface FilterSourcesBaseResult {
+    /**
+     * The filtered sources from the map and/or sources.
+     */
+    sources?: FeatureSource[];
+    /**
+     * The filtered layers from the map and/or sources.
+     */
+    layers?: LayerLike[];
+}
+/**
+ * Arguments for the "tasks.filter-sources.by-geometry-type" operation.
+ */
+export interface FilterSourcesByGeometryTypeArgs extends FilterSourcesBaseArgs {
+    /**
+     * The geometry type to filter the sources by.
+     */
+    geometryType?: GeometryJsonType | GeometryJsonType[];
+}
+/**
+ * Result of the "tasks.filter-sources.by-geometry-type" operation.
+ */
+export interface FilterSourcesByGeometryTypeResult extends FilterSourcesBaseResult {
+}
+/**
+ * Arguments for the "tasks.filter-sources.first-visible" operation.
+ */
+export interface FilterSourcesFirstVisibleArgs extends FilterSourcesBaseArgs {
+}
+/**
+ * Result of the "tasks.filter-sources.first-visible" operation.
+ */
+export interface FilterSourcesFirstVisibleResult extends FilterSourcesBaseResult {
+}
 /**
  * Arguments for search operations.
  */
@@ -218,6 +265,7 @@ export declare class TasksEvents extends EventRegistry {
     get reverseGeocoded(): Event<MapsFeatureResultArgs>;
 }
 export declare class TasksOperations extends OperationRegistry {
+    readonly filterResults: FilterSourcesOperations;
     protected readonly _prefix = "tasks";
     /**
      * Returns features that intersect a given geometry.
@@ -255,3 +303,21 @@ export declare class TasksOperations extends OperationRegistry {
      */
     get supportsSearch(): Operation<FeatureSource, boolean>;
 }
+declare class FilterSourcesOperations extends OperationRegistry {
+    readonly _prefix = "filterSources";
+    /**
+     * Returns FeatureSources that have a geometry type that matches the
+     * supplied type. Web only.
+     *
+     * @webOnly
+     */
+    get byGeometryType(): Operation<FilterSourcesByGeometryTypeArgs, FilterSourcesByGeometryTypeResult>;
+    /**
+     * Returns the first visible FeatureSource in the web map within the current
+     * scale range. Web only.
+     *
+     * @webOnly
+     */
+    get firstVisible(): Operation<FilterSourcesFirstVisibleArgs, FilterSourcesFirstVisibleResult>;
+}
+export {};

package/messaging/registry/tasks.js

@@ -1 +1 @@
-import{EventRegistry as e}from"../EventRegistry.js";import{OperationRegistry as t}from"../OperationRegistry.js";export class TasksEvents extends e{constructor(){super(...arguments),this._prefix="tasks"}get identified(){return this._get("identified")}get reverseGeocoded(){return this._get("reverse-geocoded")}}export class TasksOperations extends t{constructor(){super(...arguments),this._prefix="tasks"}get identify(){return this._get("identify")}get supportsIdentify(){return this._get("supports-identify")}get query(){return this._get("query")}get supportsQuery(){return this._get("supports-query")}get search(){return this._get("search")}get supportsSearch(){return this._get("supports-search")}}
+import{EventRegistry as e}from"../EventRegistry.js";import{OperationRegistry as t}from"../OperationRegistry.js";export class TasksEvents extends e{constructor(){super(...arguments),this._prefix="tasks"}get identified(){return this._get("identified")}get reverseGeocoded(){return this._get("reverse-geocoded")}}export class TasksOperations extends t{constructor(){super(...arguments),this.filterResults=new s(this._messages),this._prefix="tasks"}get identify(){return this._get("identify")}get supportsIdentify(){return this._get("supports-identify")}get query(){return this._get("query")}get supportsQuery(){return this._get("supports-query")}get search(){return this._get("search")}get supportsSearch(){return this._get("supports-search")}}class s extends t{constructor(){super(...arguments),this._prefix="filterSources"}get byGeometryType(){return this._get("by-geometry-type")}get firstVisible(){return this._get("first-visible")}}

package/messaging/schema/common-action.schema.json

@@ -2207,7 +2207,7 @@
                     "type": "number"
                 },
                 "outFields": {
-                    "description": "List of fields that should be returned that overrides the default out  fields. Not supported in VertiGIS Studio Mobile.",
+                    "description": "List of fields that should be returned that overrides the default out fields. Not supported in VertiGIS Studio Mobile.",
                     "items": {
                         "type": "string"
                     },

package/messaging/schema/mobile-action.schema.json

@@ -2701,7 +2701,7 @@
                     "type": "number"
                 },
                 "outFields": {
-                    "description": "List of fields that should be returned that overrides the default out  fields. Not supported in VertiGIS Studio Mobile.",
+                    "description": "List of fields that should be returned that overrides the default out fields. Not supported in VertiGIS Studio Mobile.",
                     "items": {
                         "type": "string"
                     },

package/messaging/schema/web-action.schema.json

@@ -3096,6 +3096,105 @@
             ],
             "type": "object"
         },
+        "FilterSourcesByGeometryTypeArgs": {
+            "additionalProperties": false,
+            "description": "Arguments for the \"tasks.filter-sources.by-geometry-type\" operation.",
+            "properties": {
+                "geometryType": {
+                    "anyOf": [
+                        {
+                            "items": {
+                                "$ref": "#/definitions/esri.rest-api.GeometryJson.GeometryJsonType"
+                            },
+                            "type": "array"
+                        },
+                        {
+                            "enum": [
+                                "esriGeometryEnvelope",
+                                "esriGeometryMultipoint",
+                                "esriGeometryPoint",
+                                "esriGeometryPolygon",
+                                "esriGeometryPolyline"
+                            ],
+                            "type": "string"
+                        }
+                    ],
+                    "description": "The geometry type to filter the sources by."
+                },
+                "maps": {
+                    "$ref": "MapsLike",
+                    "description": "The map from which to retrieve the sources. This argument will not be forwarded in the result of this operation."
+                },
+                "sources": {
+                    "description": "The sources to search in. This can be used in combination with the \"maps\" argument to search both.",
+                    "items": {
+                        "$ref": "@vertigis.arcgis-extensions.data.FeatureSource.FeatureSource"
+                    },
+                    "type": "array"
+                }
+            },
+            "type": "object"
+        },
+        "FilterSourcesByGeometryTypeResult": {
+            "additionalProperties": false,
+            "description": "Result of the \"tasks.filter-sources.by-geometry-type\" operation.",
+            "properties": {
+                "layers": {
+                    "description": "The filtered layers from the map and/or sources.",
+                    "items": {
+                        "$ref": "#/definitions/LayerLike"
+                    },
+                    "type": "array"
+                },
+                "sources": {
+                    "description": "The filtered sources from the map and/or sources.",
+                    "items": {
+                        "$ref": "@vertigis.arcgis-extensions.data.FeatureSource.FeatureSource"
+                    },
+                    "type": "array"
+                }
+            },
+            "type": "object"
+        },
+        "FilterSourcesFirstVisibleArgs": {
+            "additionalProperties": false,
+            "description": "Arguments for the \"tasks.filter-sources.first-visible\" operation.",
+            "properties": {
+                "maps": {
+                    "$ref": "MapsLike",
+                    "description": "The map from which to retrieve the sources. This argument will not be forwarded in the result of this operation."
+                },
+                "sources": {
+                    "description": "The sources to search in. This can be used in combination with the \"maps\" argument to search both.",
+                    "items": {
+                        "$ref": "@vertigis.arcgis-extensions.data.FeatureSource.FeatureSource"
+                    },
+                    "type": "array"
+                }
+            },
+            "type": "object"
+        },
+        "FilterSourcesFirstVisibleResult": {
+            "additionalProperties": false,
+            "description": "Result of the \"tasks.filter-sources.first-visible\" operation.",
+            "properties": {
+                "layers": {
+                    "description": "The filtered layers from the map and/or sources.",
+                    "items": {
+                        "$ref": "#/definitions/LayerLike"
+                    },
+                    "type": "array"
+                },
+                "sources": {
+                    "description": "The filtered sources from the map and/or sources.",
+                    "items": {
+                        "$ref": "@vertigis.arcgis-extensions.data.FeatureSource.FeatureSource"
+                    },
+                    "type": "array"
+                }
+            },
+            "type": "object"
+        },
         "FilterSpatialRelationship": {
             "description": "The spatial relationship for a filter effect.",
             "enum": [
@@ -4192,7 +4291,7 @@
                     "type": "number"
                 },
                 "outFields": {
-                    "description": "List of fields that should be returned that overrides the default out  fields. Not supported in VertiGIS Studio Mobile.",
+                    "description": "List of fields that should be returned that overrides the default out fields. Not supported in VertiGIS Studio Mobile.",
                     "items": {
                         "type": "string"
                     },
@@ -21785,6 +21884,30 @@
             },
             "type": "array"
         },
+        "tasks.filter-results.by-geometry-type": {
+            "description": "Returns FeatureSources that have a geometry type that matches the supplied type. Web only.",
+            "enum": [
+                "tasks.filter-results.by-geometry-type"
+            ]
+        },
+        "tasks.filter-results.by-geometry-type:input": {
+            "$ref": "#/definitions/FilterSourcesByGeometryTypeArgs"
+        },
+        "tasks.filter-results.by-geometry-type:output": {
+            "$ref": "#/definitions/FilterSourcesByGeometryTypeResult"
+        },
+        "tasks.filter-results.first-visible": {
+            "description": "Returns the first visible FeatureSource in the web map within the current scale range. Web only.",
+            "enum": [
+                "tasks.filter-results.first-visible"
+            ]
+        },
+        "tasks.filter-results.first-visible:input": {
+            "$ref": "#/definitions/FilterSourcesFirstVisibleArgs"
+        },
+        "tasks.filter-results.first-visible:output": {
+            "$ref": "#/definitions/FilterSourcesFirstVisibleResult"
+        },
         "tasks.identify": {
             "description": "Returns features that intersect a given geometry.",
             "enum": [
@@ -26326,6 +26449,38 @@
                     ],
                     "type": "object"
                 },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/tasks.filter-results.by-geometry-type:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/tasks.filter-results.by-geometry-type"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/tasks.filter-results.first-visible:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/tasks.filter-results.first-visible"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
                 {
                     "additionalProperties": false,
                     "properties": {
@@ -26729,6 +26884,12 @@
                 {
                     "$ref": "#/definitions/system.read-url"
                 },
+                {
+                    "$ref": "#/definitions/tasks.filter-results.by-geometry-type"
+                },
+                {
+                    "$ref": "#/definitions/tasks.filter-results.first-visible"
+                },
                 {
                     "$ref": "#/definitions/tasks.identify"
                 },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vertigis/viewer-spec",
-  "version": "56.15.0",
+  "version": "56.17.0",
   "license": "SEE LICENSE IN LICENSE",
   "description": "VertiGIS Viewer Specification",
   "type": "module",

package/version.d.ts

@@ -1,4 +1,4 @@
 /**
  * The current version of the VertiGIS Studio Viewer Specification.
  */
-export declare const version = "56.15.0";
+export declare const version = "56.17.0";

package/version.js

@@ -1,4 +1,4 @@
 /**
  * The current version of the VertiGIS Studio Viewer Specification.
  */
-export const version = "56.15.0";
+export const version = "56.17.0";