@vertigis/viewer-spec 58.9.1 → 58.10.0

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

@@ -0,0 +1,15 @@
+import type { Geocoder, GeocoderProperties } from "@vertigis/arcgis-extensions/tasks/geocoding/Geocoder";
+import type { ServiceModelProperties } from "../common/ServiceModelProperties";
+/**
+ * Properties that can be passed into the constructor for GeocodersService.
+ */
+export interface GeocodersModelProperties extends ServiceModelProperties {
+    /**
+     * Contains all configured geocoders.
+     */
+    geocoders?: (Geocoder | GeocoderProperties)[];
+    /**
+     * A subset of geocoders to be used for geocode operations.
+     */
+    activeGeocoders: (Geocoder | GeocoderProperties)[];
+}

package/app-config/web/GeocoderModelProperties.js

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

package/messaging/registry/geocode.d.ts

@@ -1,10 +1,16 @@
 import type Geometry from "@arcgis/core/geometry/Geometry";
 import type { Feature } from "@vertigis/arcgis-extensions/data/Feature.js";
 import type { CountResult } from "@vertigis/arcgis-extensions/tasks/CountResult.js";
-import type { AddressLike, GeocodeOptions } from "@vertigis/arcgis-extensions/tasks/geocoding/Geocoder";
+import type { AddressLike, GeocodeOptions, Geocoder } from "@vertigis/arcgis-extensions/tasks/geocoding/Geocoder";
+import type { Command } from "../Command.js";
+import { CommandRegistry } from "../CommandRegistry.js";
 import type { Operation } from "../Operation.js";
 import { OperationRegistry } from "../OperationRegistry.js";
 import type { Features } from "../common.js";
+/**
+ * A type that represents a geocoder or an array of configurable geocoders.
+ */
+export type GeocodersLike = Geocoder | Geocoder[];
 /**
  * Arguments for the "geocode.geocode" and "geocode.count" operations.
  */
@@ -57,6 +63,24 @@ export interface ReverseGeocodeArgs {
      */
     options: GeocodeOptions;
 }
+/**
+ * Arguments for the "geocode.update-default-geocoder" operation.
+ */
+export interface SetActiveGeocodersArgs {
+    /**
+     * Geocoders to be activated.
+     */
+    geocoders: GeocodersLike;
+}
+export declare class GeocodeCommands extends CommandRegistry {
+    protected readonly _prefix = "geocode";
+    /**
+     * Sets given geocoders as active. Web only.
+     *
+     * @webOnly
+     */
+    get setActiveGeocoders(): Command<SetActiveGeocodersArgs | GeocodersLike>;
+}
 export declare class GeocodeOperations extends OperationRegistry {
     protected readonly _prefix = "geocode";
     /**
@@ -84,4 +108,16 @@ export declare class GeocodeOperations extends OperationRegistry {
      * supportsReverseGeocoding capability.
      */
     get reverseGeocode(): Operation<ReverseGeocodeArgs, Feature>;
+    /**
+     * Returns all configured geocoders including the active ones. Web only.
+     *
+     * @webOnly
+     */
+    get getGeocoders(): Operation<void, Geocoder[]>;
+    /**
+     * Returns the active configured geocoders. Web only.
+     *
+     * @webOnly
+     */
+    get activeGeocoders(): Operation<void, Geocoder[]>;
 }

package/messaging/registry/geocode.js

@@ -1 +1 @@
-import{OperationRegistry as e}from"../OperationRegistry.js";export class GeocodeOperations extends e{_prefix="geocode";get geocode(){return this._get("geocode")}get batchGeocode(){return this._get("batch-geocode")}get count(){return this._get("count")}get suggest(){return this._get("suggest")}get reverseGeocode(){return this._get("reverse-geocode")}}
+import{CommandRegistry as e}from"../CommandRegistry.js";import{OperationRegistry as t}from"../OperationRegistry.js";export class GeocodeCommands extends e{_prefix="geocode";get setActiveGeocoders(){return this._get("set-active-geocoders")}}export class GeocodeOperations extends t{_prefix="geocode";get geocode(){return this._get("geocode")}get batchGeocode(){return this._get("batch-geocode")}get count(){return this._get("count")}get suggest(){return this._get("suggest")}get reverseGeocode(){return this._get("reverse-geocode")}get getGeocoders(){return this._get("get-geocoders")}get activeGeocoders(){return this._get("active-geocoders")}}

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

@@ -18879,6 +18879,18 @@
         "filter-builder.set-filter:input": {
             "$ref": "#/definitions/SetFilterArgs"
         },
+        "geocode.active-geocoders": {
+            "description": "Returns the active configured geocoders. Web only.",
+            "enum": [
+                "geocode.active-geocoders"
+            ]
+        },
+        "geocode.active-geocoders:output": {
+            "items": {
+                "$ref": "@vertigis.arcgis-extensions.tasks.geocoding.Geocoder.Geocoder"
+            },
+            "type": "array"
+        },
         "geocode.batch-geocode": {
             "description": "Finds locations corresponding to multiple addresses. The geocoder must have the supportsBatchGeocoding capability. Web only.",
             "enum": [
@@ -18915,6 +18927,18 @@
         "geocode.geocode:output": {
             "$ref": "#/definitions/Features"
         },
+        "geocode.get-geocoders": {
+            "description": "Returns all configured geocoders including the active ones. Web only.",
+            "enum": [
+                "geocode.get-geocoders"
+            ]
+        },
+        "geocode.get-geocoders:output": {
+            "items": {
+                "$ref": "@vertigis.arcgis-extensions.tasks.geocoding.Geocoder.Geocoder"
+            },
+            "type": "array"
+        },
         "geocode.reverse-geocode": {
             "description": "Finds the address at a particular location. The geocoder must have the supportsReverseGeocoding capability.",
             "enum": [
@@ -27537,6 +27561,9 @@
                 {
                     "$ref": "#/definitions/filter-builder.get-filter"
                 },
+                {
+                    "$ref": "#/definitions/geocode.active-geocoders"
+                },
                 {
                     "$ref": "#/definitions/geocode.batch-geocode"
                 },
@@ -27546,6 +27573,9 @@
                 {
                     "$ref": "#/definitions/geocode.geocode"
                 },
+                {
+                    "$ref": "#/definitions/geocode.get-geocoders"
+                },
                 {
                     "$ref": "#/definitions/geocode.reverse-geocode"
                 },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vertigis/viewer-spec",
-  "version": "58.9.1",
+  "version": "58.10.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 = "58.9.1";
+export declare const version = "58.10.0";

package/version.js

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