@vertigis/viewer-spec 53.1.0 → 53.2.0

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

@@ -0,0 +1,16 @@
+import type { Action } from "@vertigis/arcgis-extensions/support/Action";
+import type { ComponentModelProperties } from "./ComponentModelProperties.js";
+/**
+ * Properties for a query component.
+ */
+export interface QueryBuilderModelProperties extends ComponentModelProperties {
+    /**
+     * The maximum number of query results to return.
+     */
+    maxResults?: number;
+    /**
+     * The command to execute when the user executes a query. It will get an
+     * instance of `QueryArgs` passed in as context.
+     */
+    onQuery?: Action;
+}

package/app-config/web/QueryBuilderModelProperties.js

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

package/layout/schema/layout-web.xsd

@@ -59,6 +59,33 @@
         </complexType>
     </element>
 
+    <element name="filter-builder" substitutionGroup="base:component">
+        <annotation>
+            <documentation xml:lang="en">
+                A component that allows the user to interactively apply filters
+                to the maps' layers.
+            </documentation>
+        </annotation>
+        <complexType>
+            <complexContent>
+                <extension base="base:Component">
+                    <attribute name="show-cancel-button" type="boolean" default="false">
+                        <annotation>
+                            <documentation xml:lang="en">
+                                Whether or not to show a "Cancel" button. This
+                                button will cancel any pending changes to the
+                                current filter and deactivate the component.
+                                This is useful when the component is being shown
+                                in a temporary way, e.g. in a dialog. The
+                                default is false.
+                            </documentation>
+                        </annotation>
+                    </attribute>
+                </extension>
+            </complexContent>
+        </complexType>
+    </element>
+
     <element name="geometry-toolbar" substitutionGroup="base:component">
         <annotation>
             <documentation xml:lang="en">
@@ -197,15 +224,28 @@
         </complexType>
     </element>
 
-    <element name="shared-projects" substitutionGroup="base:component">
+    <element name="query-builder" substitutionGroup="base:component">
         <annotation>
             <documentation xml:lang="en">
-                A component that allows the user to manage and view shared projects.
+                A component that allows the user to interactively run queries against the
+                maps' layers.
             </documentation>
         </annotation>
         <complexType>
             <complexContent>
-                <extension base="base:Component" />
+                <extension base="base:Component">
+                    <attribute name="show-cancel-button" type="boolean" default="false">
+                        <annotation>
+                            <documentation xml:lang="en">
+                                Whether or not to show a "Cancel" button. This
+                                button will cancel any pending query and
+                                deactivate the component. This is useful when
+                                the component is being shown in a temporary way,
+                                e.g. in a dialog. The default is false.
+                            </documentation>
+                        </annotation>
+                    </attribute>
+                </extension>
             </complexContent>
         </complexType>
     </element>
@@ -235,6 +275,19 @@
         </complexType>
     </element>
 
+    <element name="shared-projects" substitutionGroup="base:component">
+        <annotation>
+            <documentation xml:lang="en">
+                A component that allows the user to manage and view shared projects.
+            </documentation>
+        </annotation>
+        <complexType>
+            <complexContent>
+                <extension base="base:Component" />
+            </complexContent>
+        </complexType>
+    </element>
+
     <element name="scale-input" substitutionGroup="base:component">
         <annotation>
             <documentation xml:lang="en">

package/messaging/registry/Commands.d.ts

@@ -6,6 +6,7 @@ import { ChartsCommands } from "./charts.js";
 import { DrawingCommands } from "./drawing.js";
 import { EditCommands } from "./edit.js";
 import { FileCommands } from "./file.js";
+import { FilterBuilderCommands } from "./filter-builder.js";
 import { GeolocationCommands } from "./geolocation.js";
 import { GeometryToolbarCommands } from "./geometry-toolbar.js";
 import { GeometryCommands } from "./geometry.js";
@@ -23,6 +24,7 @@ import { PanelCommands } from "./panel.js";
 import { PhotosCommands } from "./photos.js";
 import { PrintCommands } from "./printing.js";
 import { ProjectCommands } from "./project.js";
+import { QueryBuilderCommands } from "./query-builder.js";
 import { RegionCommands } from "./region.js";
 import { ReportsCommands } from "./reports.js";
 import { ResultsCommands } from "./results.js";
@@ -41,6 +43,7 @@ export declare class Commands extends CommandRegistry {
     readonly drawing: DrawingCommands;
     readonly edit: EditCommands;
     readonly file: FileCommands;
+    readonly filterBuilder: FilterBuilderCommands;
     readonly geolocation: GeolocationCommands;
     readonly geometry: GeometryCommands;
     readonly geometryToolbar: GeometryToolbarCommands;
@@ -58,6 +61,7 @@ export declare class Commands extends CommandRegistry {
     readonly project: ProjectCommands;
     readonly photos: PhotosCommands;
     readonly printing: PrintCommands;
+    readonly queryBuilder: QueryBuilderCommands;
     readonly region: RegionCommands;
     readonly reports: ReportsCommands;
     readonly results: ResultsCommands;

package/messaging/registry/Commands.js

@@ -1 +1 @@
-import{CommandRegistry as s}from"../CommandRegistry.js";import{AppCommands as e}from"./app.js";import{AuthCommands as t}from"./auth.js";import{BasemapCommands as i}from"./basemap.js";import{ChartsCommands as m}from"./charts.js";import{DrawingCommands as r}from"./drawing.js";import{EditCommands as o}from"./edit.js";import{FileCommands as h}from"./file.js";import{GeolocationCommands as a}from"./geolocation.js";import{GeometryToolbarCommands as n}from"./geometry-toolbar.js";import{GeometryCommands as p}from"./geometry.js";import{HighlightsCommands as g}from"./highlights.js";import{IwtmCommands as w}from"./iwtm.js";import{KpiCommands as f}from"./kpi.js";import{LayerComparisonCommands as j}from"./layer-comparison.js";import{LayerPresetsCommands as _}from"./layer-presets.js";import{LayersCommands as l}from"./layers.js";import{LocationMarkerCommands as c}from"./location-marker.js";import{MapCommands as y}from"./map.js";import{MeasurementCommands as u}from"./measurement.js";import{OfflineCommands as d}from"./offline.js";import{PanelCommands as k}from"./panel.js";import{PhotosCommands as b}from"./photos.js";import{PrintCommands as C}from"./printing.js";import{ProjectCommands as v}from"./project.js";import{RegionCommands as x}from"./region.js";import{ReportsCommands as A}from"./reports.js";import{ResultsCommands as M}from"./results.js";import{SearchCommands as P}from"./search.js";import{SketchingCommands as R}from"./sketching.js";import{StudioAnalyticsCommands as T}from"./studioAnalytics.js";import{SystemCommands as q}from"./system.js";import{UICommands as z}from"./ui.js";import{ViewerCommands as B}from"./viewer.js";import{WorkflowCommands as D}from"./workflow.js";export class Commands extends s{constructor(){super(...arguments),this.app=new e(this._messages),this.auth=new t(this._messages),this.basemap=new i(this._messages),this.charts=new m(this._messages),this.drawing=new r(this._messages),this.edit=new o(this._messages),this.file=new h(this._messages),this.geolocation=new a(this._messages),this.geometry=new p(this._messages),this.geometryToolbar=new n(this._messages),this.highlights=new g(this._messages),this.iwtm=new w(this._messages),this.kpi=new f(this._messages),this.layers=new l(this._messages),this.layerComparison=new j(this._messages),this.layerPresets=new _(this._messages),this.locationMarker=new c(this._messages),this.map=new y(this._messages),this.measurement=new u(this._messages),this.offline=new d(this._messages),this.panel=new k(this._messages),this.project=new v(this._messages),this.photos=new b(this._messages),this.printing=new C(this._messages),this.region=new x(this._messages),this.reports=new A(this._messages),this.results=new M(this._messages),this.search=new P(this._messages),this.sketching=new R(this._messages),this.studioAnalytics=new T(this._messages),this.system=new q(this._messages),this.ui=new z(this._messages),this.viewer=new B(this._messages),this.workflow=new D(this._messages)}}
+import{CommandRegistry as s}from"../CommandRegistry.js";import{AppCommands as e}from"./app.js";import{AuthCommands as t}from"./auth.js";import{BasemapCommands as i}from"./basemap.js";import{ChartsCommands as m}from"./charts.js";import{DrawingCommands as r}from"./drawing.js";import{EditCommands as o}from"./edit.js";import{FileCommands as h}from"./file.js";import{FilterBuilderCommands as a}from"./filter-builder.js";import{GeolocationCommands as n}from"./geolocation.js";import{GeometryToolbarCommands as p}from"./geometry-toolbar.js";import{GeometryCommands as g}from"./geometry.js";import{HighlightsCommands as f}from"./highlights.js";import{IwtmCommands as w}from"./iwtm.js";import{KpiCommands as j}from"./kpi.js";import{LayerComparisonCommands as _}from"./layer-comparison.js";import{LayerPresetsCommands as l}from"./layer-presets.js";import{LayersCommands as c}from"./layers.js";import{LocationMarkerCommands as u}from"./location-marker.js";import{MapCommands as y}from"./map.js";import{MeasurementCommands as d}from"./measurement.js";import{OfflineCommands as k}from"./offline.js";import{PanelCommands as b}from"./panel.js";import{PhotosCommands as C}from"./photos.js";import{PrintCommands as q}from"./printing.js";import{ProjectCommands as v}from"./project.js";import{QueryBuilderCommands as x}from"./query-builder.js";import{RegionCommands as A}from"./region.js";import{ReportsCommands as B}from"./reports.js";import{ResultsCommands as M}from"./results.js";import{SearchCommands as P}from"./search.js";import{SketchingCommands as R}from"./sketching.js";import{StudioAnalyticsCommands as T}from"./studioAnalytics.js";import{SystemCommands as z}from"./system.js";import{UICommands as D}from"./ui.js";import{ViewerCommands as E}from"./viewer.js";import{WorkflowCommands as F}from"./workflow.js";export class Commands extends s{constructor(){super(...arguments),this.app=new e(this._messages),this.auth=new t(this._messages),this.basemap=new i(this._messages),this.charts=new m(this._messages),this.drawing=new r(this._messages),this.edit=new o(this._messages),this.file=new h(this._messages),this.filterBuilder=new a(this._messages),this.geolocation=new n(this._messages),this.geometry=new g(this._messages),this.geometryToolbar=new p(this._messages),this.highlights=new f(this._messages),this.iwtm=new w(this._messages),this.kpi=new j(this._messages),this.layers=new c(this._messages),this.layerComparison=new _(this._messages),this.layerPresets=new l(this._messages),this.locationMarker=new u(this._messages),this.map=new y(this._messages),this.measurement=new d(this._messages),this.offline=new k(this._messages),this.panel=new b(this._messages),this.project=new v(this._messages),this.photos=new C(this._messages),this.printing=new q(this._messages),this.queryBuilder=new x(this._messages),this.region=new A(this._messages),this.reports=new B(this._messages),this.results=new M(this._messages),this.search=new P(this._messages),this.sketching=new R(this._messages),this.studioAnalytics=new T(this._messages),this.system=new z(this._messages),this.ui=new D(this._messages),this.viewer=new E(this._messages),this.workflow=new F(this._messages)}}

package/messaging/registry/Operations.d.ts

@@ -8,6 +8,7 @@ import { DebugConsoleOperations } from "./debugConsole.js";
 import { DrawingOperations } from "./drawing.js";
 import { EditOperations } from "./edit.js";
 import { FileOperations } from "./file.js";
+import { FilterBuilderOperations } from "./filter-builder.js";
 import { GeocodeOperations } from "./geocode.js";
 import { GeolocationOperations } from "./geolocation.js";
 import { GeometryOperations } from "./geometry.js";
@@ -20,6 +21,7 @@ import { MessagingOperations } from "./messaging.js";
 import { NetworkOperations } from "./network.js";
 import { OfflineOperations } from "./offline.js";
 import { ProjectOperations } from "./project.js";
+import { QueryBuilderOperations } from "./query-builder.js";
 import { ResultsOperations } from "./results.js";
 import { SketchingOperations } from "./sketching.js";
 import { SystemOperations } from "./system.js";
@@ -36,6 +38,7 @@ export declare class Operations extends OperationRegistry {
     readonly edit: EditOperations;
     readonly drawing: DrawingOperations;
     readonly file: FileOperations;
+    readonly filterBuilder: FilterBuilderOperations;
     readonly geocode: GeocodeOperations;
     readonly geolocation: GeolocationOperations;
     readonly geometry: GeometryOperations;
@@ -48,6 +51,7 @@ export declare class Operations extends OperationRegistry {
     readonly network: NetworkOperations;
     readonly offline: OfflineOperations;
     readonly project: ProjectOperations;
+    readonly queryBuilder: QueryBuilderOperations;
     readonly sketching: SketchingOperations;
     readonly system: SystemOperations;
     readonly results: ResultsOperations;

package/messaging/registry/Operations.js

@@ -1 +1 @@
-import{OperationRegistry as s}from"../OperationRegistry.js";import{AppOperations as e}from"./app.js";import{ArcadeOperations as t}from"./arcade.js";import{AuthOperations as i}from"./auth.js";import{BasemapOperations as m}from"./basemap.js";import{ChartOperations as o}from"./charts.js";import{DebugConsoleOperations as r}from"./debugConsole.js";import{DrawingOperations as h}from"./drawing.js";import{EditOperations as a}from"./edit.js";import{FileOperations as g}from"./file.js";import{GeocodeOperations as n}from"./geocode.js";import{GeolocationOperations as p}from"./geolocation.js";import{GeometryOperations as w}from"./geometry.js";import{HighlightsOperations as f}from"./highlights.js";import{KpiOperations as j}from"./kpi.js";import{LogViewerOperations as _}from"./logViewer.js";import{MapOperations as l}from"./map.js";import{MeasurementOperations as c}from"./measurement.js";import{MessagingOperations as u}from"./messaging.js";import{NetworkOperations as d}from"./network.js";import{OfflineOperations as k}from"./offline.js";import{ProjectOperations as y}from"./project.js";import{ResultsOperations as b}from"./results.js";import{SketchingOperations as v}from"./sketching.js";import{SystemOperations as x}from"./system.js";import{TasksOperations as C}from"./tasks.js";import{UIOperations as O}from"./ui.js";import{ViewerOperations as V}from"./viewer.js";import{WorkflowOperations as R}from"./workflow.js";export class Operations extends s{constructor(){super(...arguments),this.arcade=new t(this._messages),this.auth=new i(this._messages),this.app=new e(this._messages),this.basemap=new m(this._messages),this.charts=new o(this._messages),this.edit=new a(this._messages),this.drawing=new h(this._messages),this.file=new g(this._messages),this.geocode=new n(this._messages),this.geolocation=new p(this._messages),this.geometry=new w(this._messages),this.highlights=new f(this._messages),this.kpi=new j(this._messages),this.logViewer=new _(this._messages),this.map=new l(this._messages),this.measurement=new c(this._messages),this.messaging=new u(this._messages),this.network=new d(this._messages),this.offline=new k(this._messages),this.project=new y(this._messages),this.sketching=new v(this._messages),this.system=new x(this._messages),this.results=new b(this._messages),this.tasks=new C(this._messages),this.ui=new O(this._messages),this.viewer=new V(this._messages),this.workflow=new R(this._messages),this.debugConsole=new r(this._messages)}}
+import{OperationRegistry as s}from"../OperationRegistry.js";import{AppOperations as e}from"./app.js";import{ArcadeOperations as i}from"./arcade.js";import{AuthOperations as t}from"./auth.js";import{BasemapOperations as m}from"./basemap.js";import{ChartOperations as r}from"./charts.js";import{DebugConsoleOperations as o}from"./debugConsole.js";import{DrawingOperations as h}from"./drawing.js";import{EditOperations as a}from"./edit.js";import{FileOperations as g}from"./file.js";import{FilterBuilderOperations as n}from"./filter-builder.js";import{GeocodeOperations as p}from"./geocode.js";import{GeolocationOperations as w}from"./geolocation.js";import{GeometryOperations as f}from"./geometry.js";import{HighlightsOperations as j}from"./highlights.js";import{KpiOperations as _}from"./kpi.js";import{LogViewerOperations as l}from"./logViewer.js";import{MapOperations as u}from"./map.js";import{MeasurementOperations as c}from"./measurement.js";import{MessagingOperations as d}from"./messaging.js";import{NetworkOperations as k}from"./network.js";import{OfflineOperations as y}from"./offline.js";import{ProjectOperations as b}from"./project.js";import{QueryBuilderOperations as q}from"./query-builder.js";import{ResultsOperations as v}from"./results.js";import{SketchingOperations as x}from"./sketching.js";import{SystemOperations as B}from"./system.js";import{TasksOperations as C}from"./tasks.js";import{UIOperations as O}from"./ui.js";import{ViewerOperations as V}from"./viewer.js";import{WorkflowOperations as R}from"./workflow.js";export class Operations extends s{constructor(){super(...arguments),this.arcade=new i(this._messages),this.auth=new t(this._messages),this.app=new e(this._messages),this.basemap=new m(this._messages),this.charts=new r(this._messages),this.edit=new a(this._messages),this.drawing=new h(this._messages),this.file=new g(this._messages),this.filterBuilder=new n(this._messages),this.geocode=new p(this._messages),this.geolocation=new w(this._messages),this.geometry=new f(this._messages),this.highlights=new j(this._messages),this.kpi=new _(this._messages),this.logViewer=new l(this._messages),this.map=new u(this._messages),this.measurement=new c(this._messages),this.messaging=new d(this._messages),this.network=new k(this._messages),this.offline=new y(this._messages),this.project=new b(this._messages),this.queryBuilder=new q(this._messages),this.sketching=new x(this._messages),this.system=new B(this._messages),this.results=new v(this._messages),this.tasks=new C(this._messages),this.ui=new O(this._messages),this.viewer=new V(this._messages),this.workflow=new R(this._messages),this.debugConsole=new o(this._messages)}}

package/messaging/registry/filter-builder.d.ts

@@ -0,0 +1,70 @@
+import type { FeatureSource } from "@vertigis/arcgis-extensions/data/FeatureSource.js";
+import type { Command } from "../Command.js";
+import { CommandRegistry } from "../CommandRegistry.js";
+import type { Operation } from "../Operation.js";
+import { OperationRegistry } from "../OperationRegistry.js";
+import type { LayersLike, ModelRef } from "../common.js";
+/**
+ * A filter that can be displayed in the filter builder.
+ */
+export interface Filter {
+    /**
+     * The feature source to filter. One of `source` or `layers` is required.
+     */
+    source?: FeatureSource;
+    /**
+     * Alias of `source`, to facilitate command chaining. If multiple layers are
+     * present, only the first will be used as the source. One of `source` or
+     * `layers` is required.
+     */
+    layers?: LayersLike;
+    /**
+     * The where clause to filter by.
+     */
+    where?: string;
+}
+/**
+ * Base arguments for commands/operations that target filter builder components.
+ */
+export interface FilterBuilderArgsBase {
+    /**
+     * The filter builder component that will be targeted. If not specified, all
+     * active filter builder components in the layout will be targeted.
+     */
+    filterBuilder?: ModelRef;
+}
+/**
+ * Arguments for the "filter-builder.set-filter" command.
+ */
+export interface SetFilterArgs extends FilterBuilderArgsBase, Filter {
+}
+export declare class FilterBuilderCommands extends CommandRegistry {
+    /**
+     * Sets the current filter criteria in the filter builder and also activates
+     * the component.
+     *
+     * @webOnly
+     */
+    get displayFilter(): Command<SetFilterArgs>;
+    /**
+     * Sets the current filter criteria in the filter builder.
+     *
+     * @webOnly
+     */
+    get setFilter(): Command<SetFilterArgs>;
+}
+/**
+ * Arguments for the "filter-builder.get-filter" operation.
+ */
+export interface GetFilterArgs extends Required<FilterBuilderArgsBase> {
+}
+export declare class FilterBuilderOperations extends OperationRegistry {
+    /**
+     * Gets the currently visible filter from the specified filter builder
+     * component. Note that this filter may not have yet been applied to the
+     * layer, so it might differ from the layer's definition expression.
+     *
+     * @webOnly
+     */
+    get getFilter(): Operation<GetFilterArgs, Filter | undefined>;
+}

package/messaging/registry/filter-builder.js

@@ -0,0 +1 @@
+import{CommandRegistry as e}from"../CommandRegistry.js";import{OperationRegistry as t}from"../OperationRegistry.js";export class FilterBuilderCommands extends e{get displayFilter(){return this._messages.command("filter-builder.display-filter")}get setFilter(){return this._messages.command("filter-builder.set-filter")}}export class FilterBuilderOperations extends t{get getFilter(){return this._messages.operation("filter-builder.get-filter")}}

package/messaging/registry/query-builder.d.ts

@@ -0,0 +1,75 @@
+import type { FeatureSource } from "@vertigis/arcgis-extensions/data/FeatureSource.js";
+import type { Command } from "../Command.js";
+import { CommandRegistry } from "../CommandRegistry.js";
+import type { Operation } from "../Operation.js";
+import { OperationRegistry } from "../OperationRegistry.js";
+import type { GeometryLike, LayersLike, ModelRef } from "../common.js";
+/**
+ * A query that can be displayed in the query builder, or executed using the
+ * `tasks.query` operation.
+ */
+export interface Query {
+    /**
+     * The feature source to query. One of `source` or `layers` is required.
+     */
+    source?: FeatureSource;
+    /**
+     * Alias of `source`, to facilitate command chaining. If multiple layers are
+     * present, only the first will be used as the source. One of `source` or
+     * `layers` is required.
+     */
+    layers?: LayersLike;
+    /**
+     * The where clause to query by.
+     */
+    where?: string;
+    /**
+     * If specified, limits the results to ones that intersect the given
+     * geometry.
+     */
+    geometry?: GeometryLike;
+}
+/**
+ * Base arguments for commands/operations that target query builder components.
+ */
+export interface QueryBuilderArgsBase {
+    /**
+     * The query builder component that will be targeted. If not specified, all
+     * active query builder components in the layout will be targeted.
+     */
+    queryBuilder?: ModelRef;
+}
+/**
+ * Arguments for the "query-builder.set-query" command.
+ */
+export interface SetQueryArgs extends QueryBuilderArgsBase, Query {
+}
+export declare class QueryBuilderCommands extends CommandRegistry {
+    /**
+     * Sets the current query criteria in the query builder and also activates
+     * the component.
+     *
+     * @webOnly
+     */
+    get displayQuery(): Command<SetQueryArgs>;
+    /**
+     * Sets the current query criteria in the query builder.
+     *
+     * @webOnly
+     */
+    get setQuery(): Command<SetQueryArgs>;
+}
+/**
+ * Arguments for the "query-builder.get-query" operation.
+ */
+export interface GetQueryArgs extends Required<QueryBuilderArgsBase> {
+}
+export declare class QueryBuilderOperations extends OperationRegistry {
+    /**
+     * Gets the currently visible query from the specified query builder
+     * component.
+     *
+     * @webOnly
+     */
+    get getQuery(): Operation<GetQueryArgs, Query | undefined>;
+}

package/messaging/registry/query-builder.js

@@ -0,0 +1 @@
+import{CommandRegistry as e}from"../CommandRegistry.js";import{OperationRegistry as r}from"../OperationRegistry.js";export class QueryBuilderCommands extends e{get displayQuery(){return this._messages.command("query-builder.display-query")}get setQuery(){return this._messages.command("query-builder.set-query")}}export class QueryBuilderOperations extends r{get getQuery(){return this._messages.operation("query-builder.get-query")}}

package/messaging/registry/tasks.d.ts

@@ -134,6 +134,43 @@ export interface IdentifyArgs {
      */
     polyTolerance?: number;
 }
+/**
+ * Arguments for the tasks.query operation.
+ */
+export interface QueryArgs {
+    /**
+     * The feature source to query.
+     */
+    source: FeatureSource;
+    /**
+     * The where clause to query by.
+     */
+    where: string;
+    /**
+     * The geometry to query by.
+     */
+    geometry?: GeometryLike;
+    /**
+     * Whether geometry for features should be returned.
+     */
+    returnGeometry?: boolean;
+    /**
+     * Fields that should be returned for each feature.
+     */
+    outFields?: string[];
+    /**
+     * The spatial reference for the returned geometry.
+     */
+    outSpatialReference?: SpatialReference;
+    /**
+     * The maximum allowable offset used for generalizing returned geometries.
+     */
+    maxAllowableOffset?: number;
+    /**
+     * The maximum number of results to return.
+     */
+    maxResults?: number;
+}
 /**
  * The arguments for the tasks.supports-identify operation.
  */
@@ -151,6 +188,15 @@ export interface SupportsIdentifyArgs {
      */
     options?: IdentifyOptions;
 }
+/**
+ * The arguments for the tasks.supports-identify operation.
+ */
+export interface SupportsQueryArgs {
+    /**
+     * The feature source to query.
+     */
+    source: FeatureSource;
+}
 export declare class TasksEvents extends EventRegistry {
     /**
      * Raised when an identify task has been executed.
@@ -176,6 +222,18 @@ export declare class TasksOperations extends OperationRegistry {
      * @webOnly
      */
     get supportsIdentify(): Operation<FeatureSource | SupportsIdentifyArgs, boolean>;
+    /**
+     * Returns features that match the supplied where clause.
+     *
+     * @webOnly
+     */
+    get query(): Operation<QueryArgs, Features>;
+    /**
+     * Returns a boolean depicting whether a FeatureSource supports query.
+     *
+     * @webOnly
+     */
+    get supportsQuery(): Operation<FeatureSource | SupportsQueryArgs, boolean>;
     /**
      * Returns features that match the given search text.
      */

package/messaging/registry/tasks.js

@@ -1 +1 @@
-import{EventRegistry as e}from"../EventRegistry.js";import{OperationRegistry as s}from"../OperationRegistry.js";export class TasksEvents extends e{get identified(){return this._messages.event("tasks.identified")}get reverseGeocoded(){return this._messages.event("tasks.reverse-geocoded")}}export class TasksOperations extends s{get identify(){return this._messages.operation("tasks.identify")}get supportsIdentify(){return this._messages.operation("tasks.supports-identify")}get search(){return this._messages.operation("tasks.search")}get supportsSearch(){return this._messages.operation("tasks.supports-search")}}
+import{EventRegistry as s}from"../EventRegistry.js";import{OperationRegistry as e}from"../OperationRegistry.js";export class TasksEvents extends s{get identified(){return this._messages.event("tasks.identified")}get reverseGeocoded(){return this._messages.event("tasks.reverse-geocoded")}}export class TasksOperations extends e{get identify(){return this._messages.operation("tasks.identify")}get supportsIdentify(){return this._messages.operation("tasks.supports-identify")}get query(){return this._messages.operation("tasks.query")}get supportsQuery(){return this._messages.operation("tasks.supports-query")}get search(){return this._messages.operation("tasks.search")}get supportsSearch(){return this._messages.operation("tasks.supports-search")}}

package/messaging/registry/ui.d.ts

@@ -120,7 +120,7 @@ export declare enum NotificationType {
     /**
      * Automatically choose whether to display an app notification or system
      * notification. If the app is in the background, a system notification will
-     * be shown. If the app is in the foreground, an in-app notificaiton will be
+     * be shown. If the app is in the foreground, an in-app notification will be
      * shown. If notifications are unauthorized at the OS level, an in-app
      * notification will always be shown.
      */
@@ -178,7 +178,7 @@ export type ComponentId = string;
 export interface FocusArgs {
     /**
      * The component to focus. If the selector property is not defined, the
-     * first focusable element within the component will receieve focus. If this
+     * first focusable element within the component will receive focus. If this
      * property is not defined, only the selector will be used.
      */
     component?: ComponentId | Model;
@@ -234,7 +234,7 @@ export type NarrateArgs = string | NarrateOptions;
  */
 export interface NarrateOptions extends TranslateOptions {
     /**
-     * A timeout before the narration is excecuted. This can be used to avoid
+     * A timeout before the narration is executed. This can be used to avoid
      * focus changes that can interrupt the screen reader. Defaults to 50ms.
      */
     timeout?: number;

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

@@ -2665,6 +2665,25 @@
             ],
             "description": "A data containing object that may or may not be named."
         },
+        "Filter": {
+            "additionalProperties": false,
+            "description": "A filter that can be displayed in the filter builder.",
+            "properties": {
+                "layers": {
+                    "$ref": "#/definitions/LayersLike",
+                    "description": "Alias of `source`, to facilitate command chaining. If multiple layers are present, only the first will be used as the source. One of `source` or `layers` is required."
+                },
+                "source": {
+                    "$ref": "@vertigis.arcgis-extensions.data.FeatureSource.FeatureSource",
+                    "description": "The feature source to filter. One of `source` or `layers` is required."
+                },
+                "where": {
+                    "description": "The where clause to filter by.",
+                    "type": "string"
+                }
+            },
+            "type": "object"
+        },
         "FilterDistanceUnits": {
             "description": "The unit for calculating the buffer distance when 'distance' is specified for a filter effect.",
             "enum": [
@@ -2824,7 +2843,7 @@
                             "type": "string"
                         }
                     ],
-                    "description": "The component to focus. If the selector property is not defined, the first focusable element within the component will receieve focus. If this property is not defined, only the selector will be used."
+                    "description": "The component to focus. If the selector property is not defined, the first focusable element within the component will receive focus. If this property is not defined, only the selector will be used."
                 },
                 "selector": {
                     "description": "The CSS selector used to find an HTML Element in the DOM. If a component is also provided, the selector will only look within the component's element tree in the DOM.",
@@ -3600,6 +3619,20 @@
             ],
             "type": "object"
         },
+        "GetFilterArgs": {
+            "additionalProperties": false,
+            "description": "Arguments for the \"filter-builder.get-filter\" operation.",
+            "properties": {
+                "filterBuilder": {
+                    "$ref": "#/definitions/ModelRef",
+                    "description": "The filter builder component that will be targeted. If not specified, all active filter builder components in the layout will be targeted."
+                }
+            },
+            "required": [
+                "filterBuilder"
+            ],
+            "type": "object"
+        },
         "GetKpiDefinitionResult": {
             "additionalProperties": false,
             "description": "The result of the the charts.update-definition operation.",
@@ -3656,6 +3689,20 @@
             ],
             "type": "object"
         },
+        "GetQueryArgs": {
+            "additionalProperties": false,
+            "description": "Arguments for the \"query-builder.get-query\" operation.",
+            "properties": {
+                "queryBuilder": {
+                    "$ref": "#/definitions/ModelRef",
+                    "description": "The query builder component that will be targeted. If not specified, all active query builder components in the layout will be targeted."
+                }
+            },
+            "required": [
+                "queryBuilder"
+            ],
+            "type": "object"
+        },
         "GetViewpointResult": {
             "additionalProperties": false,
             "description": "The result of getting a Viewpoint.",
@@ -4534,7 +4581,7 @@
                     "type": "string"
                 },
                 "timeout": {
-                    "description": "A timeout before the narration is excecuted. This can be used to avoid focus changes that can interrupt the screen reader. Defaults to 50ms.",
+                    "description": "A timeout before the narration is executed. This can be used to avoid focus changes that can interrupt the screen reader. Defaults to 50ms.",
                     "type": "number"
                 }
             },
@@ -4856,6 +4903,75 @@
             },
             "type": "object"
         },
+        "Query": {
+            "additionalProperties": false,
+            "description": "A query that can be displayed in the query builder, or executed using the `tasks.query` operation.",
+            "properties": {
+                "geometry": {
+                    "$ref": "#/definitions/GeometryLike",
+                    "description": "If specified, limits the results to ones that intersect the given geometry."
+                },
+                "layers": {
+                    "$ref": "#/definitions/LayersLike",
+                    "description": "Alias of `source`, to facilitate command chaining. If multiple layers are present, only the first will be used as the source. One of `source` or `layers` is required."
+                },
+                "source": {
+                    "$ref": "@vertigis.arcgis-extensions.data.FeatureSource.FeatureSource",
+                    "description": "The feature source to query. One of `source` or `layers` is required."
+                },
+                "where": {
+                    "description": "The where clause to query by.",
+                    "type": "string"
+                }
+            },
+            "type": "object"
+        },
+        "QueryArgs": {
+            "additionalProperties": false,
+            "description": "Arguments for the tasks.query operation.",
+            "properties": {
+                "geometry": {
+                    "$ref": "#/definitions/GeometryLike",
+                    "description": "The geometry to query by."
+                },
+                "maxAllowableOffset": {
+                    "description": "The maximum allowable offset used for generalizing returned geometries.",
+                    "type": "number"
+                },
+                "maxResults": {
+                    "description": "The maximum number of results to return.",
+                    "type": "number"
+                },
+                "outFields": {
+                    "description": "Fields that should be returned for each feature.",
+                    "items": {
+                        "type": "string"
+                    },
+                    "type": "array"
+                },
+                "outSpatialReference": {
+                    "$ref": "#/definitions/esri.SpatialReference",
+                    "description": "The spatial reference for the returned geometry."
+                },
+                "returnGeometry": {
+                    "description": "Whether geometry for features should be returned.",
+                    "type": "boolean"
+                },
+                "source": {
+                    "$ref": "@vertigis.arcgis-extensions.data.FeatureSource.FeatureSource",
+                    "description": "The feature source to query."
+                },
+                "where": {
+                    "description": "The where clause to query by.",
+                    "type": "string"
+                }
+            },
+            "required": [
+                "source",
+                "where"
+            ],
+            "type": "object"
+        },
         "ReadFileArgs": {
             "additionalProperties": false,
             "description": "Arguments for the system.read-file operation.",
@@ -5483,6 +5599,29 @@
             ],
             "type": "object"
         },
+        "SetFilterArgs": {
+            "additionalProperties": false,
+            "description": "Arguments for the \"filter-builder.set-filter\" command.",
+            "properties": {
+                "filterBuilder": {
+                    "$ref": "#/definitions/ModelRef",
+                    "description": "The filter builder component that will be targeted. If not specified, all active filter builder components in the layout will be targeted."
+                },
+                "layers": {
+                    "$ref": "#/definitions/LayersLike",
+                    "description": "Alias of `source`, to facilitate command chaining. If multiple layers are present, only the first will be used as the source. One of `source` or `layers` is required."
+                },
+                "source": {
+                    "$ref": "@vertigis.arcgis-extensions.data.FeatureSource.FeatureSource",
+                    "description": "The feature source to filter. One of `source` or `layers` is required."
+                },
+                "where": {
+                    "description": "The where clause to filter by.",
+                    "type": "string"
+                }
+            },
+            "type": "object"
+        },
         "SetGeometryModeArgs": {
             "additionalProperties": false,
             "description": "Arguments for the \"sketching.set-geometry-mode\" command.",
@@ -5611,6 +5750,33 @@
             ],
             "type": "object"
         },
+        "SetQueryArgs": {
+            "additionalProperties": false,
+            "description": "Arguments for the \"query-builder.set-query\" command.",
+            "properties": {
+                "geometry": {
+                    "$ref": "#/definitions/GeometryLike",
+                    "description": "If specified, limits the results to ones that intersect the given geometry."
+                },
+                "layers": {
+                    "$ref": "#/definitions/LayersLike",
+                    "description": "Alias of `source`, to facilitate command chaining. If multiple layers are present, only the first will be used as the source. One of `source` or `layers` is required."
+                },
+                "queryBuilder": {
+                    "$ref": "#/definitions/ModelRef",
+                    "description": "The query builder component that will be targeted. If not specified, all active query builder components in the layout will be targeted."
+                },
+                "source": {
+                    "$ref": "@vertigis.arcgis-extensions.data.FeatureSource.FeatureSource",
+                    "description": "The feature source to query. One of `source` or `layers` is required."
+                },
+                "where": {
+                    "description": "The where clause to query by.",
+                    "type": "string"
+                }
+            },
+            "type": "object"
+        },
         "SetSnappingConfigurationArgs": {
             "additionalProperties": false,
             "description": "Arguments for the \"sketching.set-snapping-configuration\" command.",
@@ -6152,6 +6318,20 @@
             ],
             "type": "object"
         },
+        "SupportsQueryArgs": {
+            "additionalProperties": false,
+            "description": "The arguments for the tasks.supports-identify operation.",
+            "properties": {
+                "source": {
+                    "$ref": "@vertigis.arcgis-extensions.data.FeatureSource.FeatureSource",
+                    "description": "The feature source to query."
+                }
+            },
+            "required": [
+                "source"
+            ],
+            "type": "object"
+        },
         "SwitchActiveNodeArgs": {
             "additionalProperties": false,
             "description": "Deprecated - use \"sketching.set-active-points\" with {@link SetActivePointsArgs}.",
@@ -17011,6 +17191,36 @@
             ],
             "type": "string"
         },
+        "filter-builder.display-filter": {
+            "description": "Sets the current filter criteria in the filter builder and also activates the component.",
+            "enum": [
+                "filter-builder.display-filter"
+            ]
+        },
+        "filter-builder.display-filter:input": {
+            "$ref": "#/definitions/SetFilterArgs"
+        },
+        "filter-builder.get-filter": {
+            "description": "Gets the currently visible filter from the specified filter builder component. Note that this filter may not have yet been applied to the layer, so it might differ from the layer's definition expression.",
+            "enum": [
+                "filter-builder.get-filter"
+            ]
+        },
+        "filter-builder.get-filter:input": {
+            "$ref": "#/definitions/GetFilterArgs"
+        },
+        "filter-builder.get-filter:output": {
+            "$ref": "#/definitions/Filter"
+        },
+        "filter-builder.set-filter": {
+            "description": "Sets the current filter criteria in the filter builder.",
+            "enum": [
+                "filter-builder.set-filter"
+            ]
+        },
+        "filter-builder.set-filter:input": {
+            "$ref": "#/definitions/SetFilterArgs"
+        },
         "geocode.batch-geocode": {
             "description": "Finds locations corresponding to multiple addresses. The geocoder must have the supportsBatchGeocoding capability.",
             "enum": [
@@ -19114,6 +19324,36 @@
         "project.show-share-link:input": {
             "$ref": "#/definitions/SharedProject"
         },
+        "query-builder.display-query": {
+            "description": "Sets the current query criteria in the query builder and also activates the component.",
+            "enum": [
+                "query-builder.display-query"
+            ]
+        },
+        "query-builder.display-query:input": {
+            "$ref": "#/definitions/SetQueryArgs"
+        },
+        "query-builder.get-query": {
+            "description": "Gets the currently visible query from the specified query builder component.",
+            "enum": [
+                "query-builder.get-query"
+            ]
+        },
+        "query-builder.get-query:input": {
+            "$ref": "#/definitions/GetQueryArgs"
+        },
+        "query-builder.get-query:output": {
+            "$ref": "#/definitions/Query"
+        },
+        "query-builder.set-query": {
+            "description": "Sets the current query criteria in the query builder.",
+            "enum": [
+                "query-builder.set-query"
+            ]
+        },
+        "query-builder.set-query:input": {
+            "$ref": "#/definitions/SetQueryArgs"
+        },
         "region.set-measurement-system": {
             "description": "Sets the current measurement system.",
             "enum": [
@@ -20262,6 +20502,18 @@
         "tasks.identify:output": {
             "$ref": "#/definitions/Features"
         },
+        "tasks.query": {
+            "description": "Returns features that match the supplied where clause.",
+            "enum": [
+                "tasks.query"
+            ]
+        },
+        "tasks.query:input": {
+            "$ref": "#/definitions/QueryArgs"
+        },
+        "tasks.query:output": {
+            "$ref": "#/definitions/Features"
+        },
         "tasks.search": {
             "description": "Returns features that match the given search text.",
             "enum": [
@@ -20293,6 +20545,25 @@
         "tasks.supports-identify:output": {
             "type": "boolean"
         },
+        "tasks.supports-query": {
+            "description": "Returns a boolean depicting whether a FeatureSource supports query.",
+            "enum": [
+                "tasks.supports-query"
+            ]
+        },
+        "tasks.supports-query:input": {
+            "anyOf": [
+                {
+                    "$ref": "@vertigis.arcgis-extensions.data.FeatureSource.FeatureSource"
+                },
+                {
+                    "$ref": "#/definitions/SupportsQueryArgs"
+                }
+            ]
+        },
+        "tasks.supports-query:output": {
+            "type": "boolean"
+        },
         "tasks.supports-search": {
             "description": "Returns a boolean depicting whether a FeatureSource supports search.",
             "enum": [
@@ -20902,6 +21173,38 @@
                     ],
                     "type": "object"
                 },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/filter-builder.display-filter:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/filter-builder.display-filter"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/filter-builder.set-filter:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/filter-builder.set-filter"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
                 {
                     "additionalProperties": false,
                     "properties": {
@@ -22246,6 +22549,38 @@
                     ],
                     "type": "object"
                 },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/query-builder.display-query:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/query-builder.display-query"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/query-builder.set-query:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/query-builder.set-query"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
                 {
                     "additionalProperties": false,
                     "properties": {
@@ -22990,6 +23325,12 @@
                 {
                     "$ref": "#/definitions/edit.update-session"
                 },
+                {
+                    "$ref": "#/definitions/filter-builder.display-filter"
+                },
+                {
+                    "$ref": "#/definitions/filter-builder.set-filter"
+                },
                 {
                     "$ref": "#/definitions/geolocation.auto-recenter"
                 },
@@ -23248,6 +23589,12 @@
                 {
                     "$ref": "#/definitions/project.show-share-link"
                 },
+                {
+                    "$ref": "#/definitions/query-builder.display-query"
+                },
+                {
+                    "$ref": "#/definitions/query-builder.set-query"
+                },
                 {
                     "$ref": "#/definitions/region.set-measurement-system"
                 },
@@ -23555,6 +23902,22 @@
                     ],
                     "type": "object"
                 },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/filter-builder.get-filter:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/filter-builder.get-filter"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
                 {
                     "additionalProperties": false,
                     "properties": {
@@ -23955,6 +24318,22 @@
                     ],
                     "type": "object"
                 },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/query-builder.get-query:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/query-builder.get-query"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
                 {
                     "additionalProperties": false,
                     "properties": {
@@ -24435,6 +24814,22 @@
                     ],
                     "type": "object"
                 },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/tasks.query:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/tasks.query"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
                 {
                     "additionalProperties": false,
                     "properties": {
@@ -24467,6 +24862,22 @@
                     ],
                     "type": "object"
                 },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "arguments": {
+                            "$ref": "#/definitions/tasks.supports-query:input"
+                        },
+                        "name": {
+                            "$ref": "#/definitions/tasks.supports-query"
+                        }
+                    },
+                    "required": [
+                        "name",
+                        "arguments"
+                    ],
+                    "type": "object"
+                },
                 {
                     "additionalProperties": false,
                     "properties": {
@@ -24586,6 +24997,9 @@
                 {
                     "$ref": "#/definitions/edit.create-feature"
                 },
+                {
+                    "$ref": "#/definitions/filter-builder.get-filter"
+                },
                 {
                     "$ref": "#/definitions/geocode.batch-geocode"
                 },
@@ -24685,6 +25099,9 @@
                 {
                     "$ref": "#/definitions/project.get-shared-content"
                 },
+                {
+                    "$ref": "#/definitions/query-builder.get-query"
+                },
                 {
                     "$ref": "#/definitions/results.configure-upload-data"
                 },
@@ -24784,12 +25201,18 @@
                 {
                     "$ref": "#/definitions/tasks.identify"
                 },
+                {
+                    "$ref": "#/definitions/tasks.query"
+                },
                 {
                     "$ref": "#/definitions/tasks.search"
                 },
                 {
                     "$ref": "#/definitions/tasks.supports-identify"
                 },
+                {
+                    "$ref": "#/definitions/tasks.supports-query"
+                },
                 {
                     "$ref": "#/definitions/tasks.supports-search"
                 },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vertigis/viewer-spec",
-  "version": "53.1.0",
+  "version": "53.2.0",
   "license": "SEE LICENSE IN LICENSE",
   "description": "VertiGIS Viewer Specification",
   "type": "module",
@@ -36,7 +36,7 @@
   "author": "VertiGIS Ltd.",
   "peerDependencies": {
     "@arcgis/core": "*",
-    "@vertigis/arcgis-extensions": ">= 40.1.0  < 41.0.0"
+    "@vertigis/arcgis-extensions": ">= 40.2.0  < 41.0.0"
   },
   "devDependencies": {
     "@prettier/plugin-xml": "2.2.0",

package/version.d.ts

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

package/version.js

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