@arcgis/core 5.0.0-next.51 → 5.0.0-next.53

package/rest/support/QueryMixin.d.ts

@@ -1,4 +1,205 @@
-import "../../interfaces";
+import type SpatialReference from "../../geometry/SpatialReference.js";
+import type TimeExtent from "../../time/TimeExtent.js";
+import type { GeometryUnion } from "../../geometry/support/typeUtils.js";
+import type { MeshProperties } from "../../geometry/Mesh.js";
+import type { PolylineProperties } from "../../geometry/Polyline.js";
+import type { PolygonProperties } from "../../geometry/Polygon.js";
+import type { PointProperties } from "../../geometry/Point.js";
+import type { MultipointProperties } from "../../geometry/Multipoint.js";
+import type { ExtentProperties } from "../../geometry/Extent.js";
+import type { SpatialReferenceProperties } from "../../geometry/SpatialReference.js";
+import type { TimeExtentProperties } from "../../time/TimeExtent.js";
 
-import QueryMixin = __esri.QueryMixin;
-export { QueryMixin };
+export interface QueryMixinProperties extends Partial<Pick<QueryMixin, "cacheHint" | "distance" | "spatialRelationship" | "units" | "where">> {
+  /**
+   * The geometry to apply to the spatial filter. The [spatialRelationship](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-QueryMixin.html#spatialRelationship)
+   * will indicate how the geometry should be used to query features.
+   *
+   * > [!WARNING]
+   * >
+   * > **Known Limitations**
+   * >
+   * > [Mesh](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html) geometry types are currently not supported.
+   */
+  geometry?: ((ExtentProperties & { type: "extent" }) | (MultipointProperties & { type: "multipoint" }) | (PointProperties & { type: "point" }) | (PolygonProperties & { type: "polygon" }) | (PolylineProperties & { type: "polyline" }) | (MeshProperties & { type: "mesh" })) | null;
+  /**
+   * The spatial reference for the returned geometry. If not specified, the geometry is returned in the spatial
+   * reference of the queried layer.
+   */
+  outSpatialReference?: SpatialReferenceProperties | null;
+  /**
+   * A time extent for a temporal query against [time-aware layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#timeInfo).
+   * For example, it can be used to discover all crimes that occurred during the
+   * night shift from 10 PM to 6 AM on a particular date.
+   *
+   * @example
+   * let layer = new FeatureLayer( ... );
+   * let timeExtent = new TimeExtent({
+   *   start: new Date(1992, 0, 1),
+   *   end: new Date(1992, 11, 31)
+   * });
+   * let timeQuery = new Query({
+   *   timeExtent: timeExtent
+   * });
+   * layerView.queryFeatures(timeQuery).then(function(featureSet) { ... });
+   */
+  timeExtent?: TimeExtentProperties | null;
+}
+
+/**
+ * Mixin for different query classes. It has common methods and properties belonging to these query classes.
+ *
+ * @since 4.31
+ */
+export abstract class QueryMixin {
+  constructor(...args: any[]);
+  /**
+   * Indicates if the service should cache the query results. It only applies if the layer's
+   * [capabilities.query.supportsCacheHint](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) is set to `true`.
+   * Use only for queries that have the same parameters every time the app is used.
+   * Some examples of cacheable queries:
+   * * Queries that fetch {@link rest/support/QueryMixin#outStatistics statistics} or {@link rest/support/QueryMixin#returnGeometry features} on app load.
+   * * Queries based on [preset input](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-QueryMixin.html#where), for example, a drop-down list of US states.
+   * * Queries based on [preset extents](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-QueryMixin.html#geometry), for example bookmarks, in web maps.
+   */
+  cacheHint?: boolean | null;
+  /**
+   * Specifies a search distance from a given [geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-QueryMixin.html#geometry) in a spatial query.
+   * The [units property](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-QueryMixin.html#units) indicates the unit of measurement. In essence, setting this property
+   * creates a buffer at the specified size around the input [geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-QueryMixin.html#geometry). The query will use that
+   * buffer to return features in the layer or layer view that adhere to the to the indicated [spatial relationship](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-QueryMixin.html#spatialRelationship).
+   *
+   * If querying a feature service, the [supportsQueryWithDistance](https://developers.arcgis.com/rest/services-reference/query-feature-service-layer-.htm)
+   * capability must be `true`.
+   */
+  distance?: number | null;
+  /**
+   * The geometry to apply to the spatial filter. The [spatialRelationship](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-QueryMixin.html#spatialRelationship)
+   * will indicate how the geometry should be used to query features.
+   *
+   * > [!WARNING]
+   * >
+   * > **Known Limitations**
+   * >
+   * > [Mesh](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Mesh.html) geometry types are currently not supported.
+   */
+  get geometry(): GeometryUnion | null | undefined;
+  set geometry(value: ((ExtentProperties & { type: "extent" }) | (MultipointProperties & { type: "multipoint" }) | (PointProperties & { type: "point" }) | (PolygonProperties & { type: "polygon" }) | (PolylineProperties & { type: "polyline" }) | (MeshProperties & { type: "mesh" })) | null | undefined);
+  /**
+   * The spatial reference for the returned geometry. If not specified, the geometry is returned in the spatial
+   * reference of the queried layer.
+   */
+  get outSpatialReference(): SpatialReference | null | undefined;
+  set outSpatialReference(value: SpatialReferenceProperties | null | undefined);
+  /**
+   * For spatial queries, this parameter defines the spatial relationship to query features in the layer or layer view against the input [geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-QueryMixin.html#geometry).
+   * The spatial relationships discover how features are spatially related to each other.
+   * For example, you may want to know if a polygon representing a county completely contains points representing settlements.
+   *
+   * The spatial relationship is determined by whether the boundaries or interiors of a geometry intersect.
+   * * Boundary — The endpoints of all linear parts for line features, or the linear outline of a polygon. Only lines and polygons have boundaries.
+   * * Interior — Points are entirely interior and have no boundary. For lines and polygons, the interior is any part of the geometry that is not part of the boundary.
+   *
+   * The possible values for this parameter are described below and the images highlight the geometries returned for the specified spatial
+   * relationship for given geometries.
+   *
+   *  The `intersects` spatial relationship returns features in the layer view that intersect the query [geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-QueryMixin.html#geometry).
+   *
+   * ![intersects](https://developers.arcgis.com/javascript/latest/assets/img/apiref/layers/spatialRelationships/intersects.png)
+   *
+   * The `contains` spatial relationship returns features in the layer view that are completely contained by the query [geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-QueryMixin.html#geometry).
+   *
+   * ![contains](https://developers.arcgis.com/javascript/latest/assets/img/apiref/layers/spatialRelationships/contains.png)
+   *
+   * The `crosses` spatial relationship returns features in the layer view when the interior of a query [geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-QueryMixin.html#geometry) comes into contact with
+   * the interior or boundary of features in the layer view. In other words, the geometries share some interior area, but not all interior area.
+   *
+   * ![crosses](https://developers.arcgis.com/javascript/latest/assets/img/apiref/layers/spatialRelationships/crosses.png)
+   *
+   * The `envelope-intersects` spatial relationship returns features in the layer view that intersect the envelope (or extent)
+   * of the filter [geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-QueryMixin.html#geometry).
+   *
+   * ![envelope-intersects](https://developers.arcgis.com/javascript/latest/assets/img/apiref/layers/spatialRelationships/envelope-intersects.png)
+   *
+   * The `overlaps` spatial relationship returns features in the layer view that overlap the query [geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-QueryMixin.html#geometry).
+   * Only features of the same geometry can be compared.
+   *
+   * ![overlaps](https://developers.arcgis.com/javascript/latest/assets/img/apiref/layers/spatialRelationships/overlap.png)
+   *
+   * The `touches` spatial relationship returns features in the layer view that touch the query [geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-QueryMixin.html#geometry).
+   * The boundaries of the geometries intersect, but not their interiors.
+   *
+   * ![touches](https://developers.arcgis.com/javascript/latest/assets/img/apiref/layers/spatialRelationships/touches.png)
+   *
+   * The `within` spatial relationship returns features in the layer view that completely contain the query [geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-QueryMixin.html#geometry).
+   * In other words, the filter geometry is completely `within` the features in the layer view. It is opposite of
+   * `contains`.
+   *
+   * ![within](https://developers.arcgis.com/javascript/latest/assets/img/apiref/layers/spatialRelationships/within.png)
+   *
+   * The `disjoint` spatial relationship returns features in the layer view that do not intersect the query [geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-QueryMixin.html#geometry) in anyway.
+   * Opposite of `intersects`.
+   *
+   * ![disjoint](https://developers.arcgis.com/javascript/latest/assets/img/apiref/layers/spatialRelationships/disjoint.png)
+   *
+   * > [!WARNING]
+   * >
+   * > **Known Limitations**
+   * >
+   * > For spatial queries on 3D Object SceneLayers and BuildingSceneLayers the spatial relationship is evaluated based on the
+   * > [Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html) of the feature and not the footprint. This means that a feature might be
+   * > returned from the query, even though its footprint is not in a spatial relationship with the [geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-QueryMixin.html#geometry).
+   * > Currently only `intersects`, `contains`, and `disjoint` [spatialRelationships](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#spatialRelationship) are supported on spatial
+   * > [queries](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) for 3D Object SceneLayers and BuildingSceneLayers.
+   *
+   * @default intersects
+   * @example
+   * let query = new Query({
+   *   spatialRelationship: "contains"
+   * });
+   */
+  spatialRelationship: "intersects" | "contains" | "crosses" | "disjoint" | "envelope-intersects" | "index-intersects" | "overlaps" | "touches" | "within" | "relation";
+  /**
+   * A time extent for a temporal query against [time-aware layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#timeInfo).
+   * For example, it can be used to discover all crimes that occurred during the
+   * night shift from 10 PM to 6 AM on a particular date.
+   *
+   * @example
+   * let layer = new FeatureLayer( ... );
+   * let timeExtent = new TimeExtent({
+   *   start: new Date(1992, 0, 1),
+   *   end: new Date(1992, 11, 31)
+   * });
+   * let timeQuery = new Query({
+   *   timeExtent: timeExtent
+   * });
+   * layerView.queryFeatures(timeQuery).then(function(featureSet) { ... });
+   */
+  get timeExtent(): TimeExtent | null | undefined;
+  set timeExtent(value: TimeExtentProperties | null | undefined);
+  /**
+   * The unit for calculating the buffer distance when [distance](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-QueryMixin.html#distance) is specified in spatial queries.
+   * If `units` is not specified, the unit is derived from the geometry spatial reference.
+   * If the geometry spatial reference is not specified, the unit is derived from the feature service data spatial reference.
+   * For service-based queries, this parameter only applies if the layer's
+   * [capabilities.query.supportsDistance](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) is `true`.
+   *
+   * @example
+   * // Query at a distance in pixels of the query geometry.
+   * // Use the unit of the query geometry's spatial reference.
+   * layerView.queryFeatures({
+   *   geometry: event.mapPoint,
+   *   distance: 2 * view.resolution,
+   *   returnGeometry: true
+   * }).then(processResults);
+   */
+  units?: "feet" | "miles" | "nautical-miles" | "us-nautical-miles" | "meters" | "kilometers" | null;
+  /**
+   * A where clause for the query. Any legal SQL where clause operating on the fields in the layer is allowed.
+   * Be sure to have the correct sequence of single and double quotes when writing the where clause in JavaScript.
+   *
+   * @example query.where = "NAME = '" + stateName + "'";
+   * @example query.where = "POP04 > " + population;
+   */
+  where?: string | null;
+}

package/rest/support/RasterData.d.ts

@@ -1,4 +1,59 @@
-import "../../interfaces";
+import type { JSONSupport, JSONSupportMixinProperties } from "../../core/JSONSupport.js";
 
-import RasterData = __esri.RasterData;
-export default RasterData;
+export interface RasterDataProperties extends JSONSupportMixinProperties, Partial<Pick<RasterData, "itemId" | "url">> {}
+
+export type RasterDataType = "image-service";
+
+/**
+ * A geoprocessing data type representing raster data file or service.
+ *
+ * @since 4.20
+ * @see [Geoprocessing Data Types | GPRasterDataLayer](https://developers.arcgis.com/rest/services-reference/enterprise/gp-data-types/#gprasterdatalayer)
+ * @example
+ * // Create a new RasterData object representing a tif image.
+ * const rasterData = new RasterData({
+ *   url: "https://myserver/lake.tif"
+ * });
+ */
+export default class RasterData extends JSONSupport {
+  constructor(properties?: RasterDataProperties);
+  /**
+   * The image type (e.g. "jpg" or "tif") when this data type references an image.
+   *
+   * @example
+   * const parameterValue = await jobInfo.fetchResultData("Output_TIF_GDB");
+   * console.log(parameterValue.dataType); // "raster-data-layer"
+   *
+   * const rasterData = parameterValue.value;
+   * console.log(rasterData.url);    // "https://machine.domain.com/webadaptor/rest/directories/arcgisoutput/GPServer/_ags_africa_150m.tif"
+   * console.log(rasterData.format); // "tif"
+   */
+  get format(): string | null | undefined;
+  /**
+   * The ID of the portal item containing the raster data file or service.
+   *
+   * @example
+   * const rasterData = new RasterData({
+   *   itemId: "my-portal-item-id"
+   * });
+   */
+  accessor itemId: string | null | undefined;
+  /**
+   * When the output data type is an image service, this property will return `image-service`.
+   *
+   * @example
+   * const rasterData = parameterValue.value;
+   * const { url, format, type } = rasterData;
+   * if (url) {
+   *   if (type === "image-service") {
+   *     console.log(`The url to the image service is: ${url}`);
+   *   else {
+   *     console.log(`The url to the raster data file is: ${url}`);
+   *     console.log(`The raster data file is a ${format} image`);
+   *   }
+   * }
+   */
+  get type(): RasterDataType | null | undefined;
+  /** The URL to the raster data file or image service. */
+  accessor url: string | null | undefined;
+}

package/rest/support/RelationParameters.d.ts

@@ -1,4 +1,54 @@
-import "../../interfaces";
+import type { JSONSupport, JSONSupportMixinProperties } from "../../core/JSONSupport.js";
+import type { GeometryUnion } from "../../geometry/support/typeUtils.js";
 
-import RelationParameters = __esri.RelationParameters;
-export default RelationParameters;
+export interface RelationParametersProperties extends JSONSupportMixinProperties, Partial<Pick<RelationParameters, "geometries1" | "geometries2" | "relation" | "relationParameter">> {}
+
+/**
+ * Sets the relation and other parameters for the [relation()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-geometryService.html#relation) operation.
+ *
+ * @since 4.0
+ * @see [relation()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-geometryService.html#relation)
+ * @see [ArcGIS REST API - Relation](https://developers.arcgis.com/rest/services-reference/relation.htm)
+ */
+export default class RelationParameters extends JSONSupport {
+  constructor(properties?: RelationParametersProperties);
+  /**
+   * The first array of geometries to compute the relation. The structure of each geometry in the array is same as the structure
+   * of the json geometry objects returned by the ArcGIS REST API.
+   */
+  accessor geometries1: GeometryUnion[] | null | undefined;
+  /**
+   * The second array of geometries to compute the relation. The structure of each geometry in the array is same as the structure
+   * of the json geometry objects returned by the ArcGIS REST API.
+   */
+  accessor geometries2: GeometryUnion[] | null | undefined;
+  /**
+   * The spatial relationship to be tested between the two input geometry arrays. See table below for a list of possible values.
+   * If the relation is specified as `relation`, the `relationParameter` parameter describes the spatial
+   * relationship and must be specified.
+   *
+   * Value | Description
+   * ------|------------
+   * cross | Two polylines cross if they share only points in common, at least one of which is not an endpoint. A polyline and an polygon cross if they share a polyline in common on the interior of the polygon which is not equivalent to the entire polyline. Cross is a Clementini operator. If either one of the geometries is empty, the geometries do not cross.
+   * disjoint | Two geometries are disjoint if their intersection is empty. Two geometries intersect if disjoint is "false".
+   * in | The base geometry is within the comparison geometry if the base geometry is the intersection of the geometries and the intersection of their interiors is not empty. An empty geometry is within another geometry, unless the other geometry is empty.
+   * interior-intersection | Geometries intersect excluding boundary touch.
+   * intersection | Geometry interiors intersect or boundaries touch, same as 'not disjoint'.
+   * line-coincidence | The boundaries of the geometries must share an intersection, but the relationship between the interiors of the shapes is not considered (they could overlap, one could be contained in the other, or their interiors could be disjoint). This relation applies to polylines and polygons.
+   * line-touch | Two geometries are said to touch when the intersection of the geometries is non-empty, but the intersection of their interiors is empty. This evaluates if the touch occurs along a boundary (not a point). Valid for polygons.
+   * overlap | Two polylines share a common sub-line, or two polygons share a common sub-area. Two geometries do not overlap if either one is empty.
+   * point-touch | Two geometries are said to touch when the intersection of the geometries is non-empty, but the intersection of their interiors is empty. This evaluates if the touch occurs at a point (not a boundary).
+   * relation | Allows specification of any relationship defined using the Shape Comparison Language. If this value is used, a value for `relationParameter` must be specified.
+   * touch | The union of point touch and line touch. Two geometries are said to touch when the intersection of the geometries is non-empty, but the intersection of their interiors is empty. For example, a point touches a polyline only if the point is coincident with one of the polyline end points. If either one of the two geometries is empty, the geometries are not touched.
+   * within | Same as `in` but also allows polylines that are strictly on the boundaries of polygons to be considered in the polygon.
+   */
+  accessor relation: "cross" | "disjoint" | "in" | "interior-intersection" | "intersection" | "line-coincidence" | "line-touch" | "overlap" | "point-touch" | "relation" | "touch" | "within" | null | undefined;
+  /**
+   * The string describes the spatial relationship to be tested when `RelationParameters.relation = 'relation'`.
+   * The [Relational functions for ST_Geometry](https://pro.arcgis.com/en/pro-app/latest/help/data/databases/pdf/stgeometry_reference.pdf) topic has additional details.
+   * An example of a valid string is: `FFFTTT**`.
+   * Also see the description of [relateOperator](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-operators-relateOperator.html) for
+   * additional examples of valid strings.
+   */
+  accessor relationParameter: string | null | undefined;
+}

package/rest/support/RelationshipQuery.d.ts

@@ -1,4 +1,148 @@
-import "../../interfaces";
+import type SpatialReference from "../../geometry/SpatialReference.js";
+import type { JSONSupport, JSONSupportMixinProperties } from "../../core/JSONSupport.js";
+import type { ObjectId } from "../../views/IObjectId.js";
+import type { SpatialReferenceProperties } from "../../geometry/SpatialReference.js";
 
-import RelationshipQuery = __esri.RelationshipQuery;
-export default RelationshipQuery;
+export interface RelationshipQueryProperties extends JSONSupportMixinProperties, Partial<Pick<RelationshipQuery, "cacheHint" | "gdbVersion" | "geometryPrecision" | "maxAllowableOffset" | "num" | "objectIds" | "orderByFields" | "outFields" | "relationshipId" | "returnGeometry" | "returnM" | "returnZ" | "start" | "where">> {
+  /**
+   * The historic moment to query. This parameter applies only if the `supportsHistoricMoment`
+   * on [FeatureLayer#capabilities](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) property of the layer is set to `true`.
+   *
+   * @since 4.7
+   */
+  historicMoment?: (Date | number | string) | null;
+  /**
+   * The spatial reference for the returned geometry. If `outSpatialReference` is not defined, the
+   * [View#spatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#spatialReference) of the view is used.
+   */
+  outSpatialReference?: SpatialReferenceProperties | null;
+}
+
+/**
+ * This class defines parameters for executing queries for related records from a layer.
+ * Once a RelationshipQuery object's properties are defined, it can then be passed into the
+ * [executeRelationshipQuery()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-query.html#executeRelationshipQuery) and
+ * [FeatureLayer#queryRelatedFeatures()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#queryRelatedFeatures)
+ * methods, which will return [FeatureSets](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html) grouped by source layer/table objectIds.
+ *
+ * @since 4.20
+ * @see [query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-query.html)
+ * @see [Sample - Query Related Features](https://developers.arcgis.com/javascript/latest/sample-code/query-related-features/)
+ */
+export default class RelationshipQuery extends JSONSupport {
+  constructor(properties?: RelationshipQueryProperties);
+  /**
+   * Indicates if the service should cache the relationship query results. It only applies if the layer's
+   * [capabilities.queryRelated.supportsCacheHint](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) is set to `true`.
+   * Use only for queries that have the same parameters every time the app is used.
+   * Some examples of cacheable queries:
+   * * Queries based on [preset input](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RelationshipQuery.html#where), for example, a drop-down list of US states.
+   * * Queries based on {@link rest/support/RelationshipQuery#geometry preset extents}, for example bookmarks, in web maps.
+   *
+   * @since 4.24
+   */
+  accessor cacheHint: boolean | null | undefined;
+  /**
+   * Specify the geodatabase version to query.
+   *
+   * @since 4.7
+   */
+  accessor gdbVersion: string | null | undefined;
+  /** Specify the number of decimal places for the geometries returned by the query operation. */
+  accessor geometryPrecision: number;
+  /**
+   * The historic moment to query. This parameter applies only if the `supportsHistoricMoment`
+   * on [FeatureLayer#capabilities](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) property of the layer is set to `true`.
+   *
+   * @since 4.7
+   */
+  get historicMoment(): Date | null | undefined;
+  set historicMoment(value: (Date | number | string) | null | undefined);
+  /**
+   * The maximum allowable offset used for generalizing geometries returned by the query operation.
+   * The offset is in the units of `outSpatialReference`. If `outSpatialReference` is not defined, the
+   * [View#spatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#spatialReference) of the view is used.
+   */
+  accessor maxAllowableOffset: number;
+  /**
+   * The number of features to retrieve. This option should be used in conjunction with the [start property](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RelationshipQuery.html#start). Use this to
+   * implement paging (i.e. to retrieve "pages" of results when querying).
+   *
+   * If not provided, but an instance of Query has a `start` property, then the default value of `num` is 10.
+   * If neither `num` nor `start` properties are provided, then the default value of `num` is equal to the
+   * `maxRecordCount` of the service, which can be found at the REST endpoint of the FeatureLayer.
+   */
+  accessor num: number;
+  /** An array of objectIds for the features in the layer/table being queried. */
+  accessor objectIds: ObjectId[] | null | undefined;
+  /**
+   * One or more field names used to order the query results. Specify `ASC` (ascending) or `DESC`
+   * (descending) after the field name to control the order. The default order is `ASC`.
+   *
+   * > [!WARNING]
+   * >
+   * > **Known Limitations**
+   * >
+   * > If querying a [MapImageLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html), then `supportsAdvancedQueries` must be `true` on the service.
+   * > For [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html), `FeatureLayer.capabilities.queryRelated.supportsOrderBy` must be `true`.
+   *
+   * @see [FeatureLayer#capabilities](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities)
+   * @example query.orderByFields = ["STATE_NAME DESC"];
+   */
+  accessor orderByFields: string[] | null | undefined;
+  /**
+   * Attribute fields to include in the FeatureSet. Fields must exist in the map layer. You must list actual
+   * field names rather than the alias names. You are, however, able to use the alias names when you display
+   * the results.
+   *
+   * When specifying the output fields, you should limit the fields to only those you expect to use in the
+   * query or the results. The fewer fields you include, the faster the response will be.
+   *
+   * Each query must have access to the Shape and ObjectId fields for a layer. However, your list of fields does
+   * not need to include these two fields.
+   *
+   * @example query.outFields = [ "NAME", "STATE_ABBR", "POP04" ];
+   */
+  accessor outFields: string[] | null | undefined;
+  /**
+   * The spatial reference for the returned geometry. If `outSpatialReference` is not defined, the
+   * [View#spatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#spatialReference) of the view is used.
+   */
+  get outSpatialReference(): SpatialReference | null | undefined;
+  set outSpatialReference(value: SpatialReferenceProperties | null | undefined);
+  /**
+   * The ID of the relationship to be queried. The ids for the relationships the table or layer participates in are listed in the
+   * ArcGIS Services directory.
+   * The ID of the relationship to be queried. The relationships that this layer/table participates in are included in the Feature Service Layer resource response. Records in tables/layers corresponding to the related table/layer of the relationship are queried.
+   */
+  accessor relationshipId: number;
+  /**
+   * If `true`, each feature in the [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html) includes the geometry. Set to `false` (default)
+   * if you do not plan to include highlighted features on a map since the geometry makes up a significant portion of the response.
+   *
+   * @default false
+   */
+  accessor returnGeometry: boolean;
+  /** If `true`, and [returnGeometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RelationshipQuery.html#returnGeometry) is `true`, then m-values are included in the geometry. */
+  accessor returnM: boolean;
+  /** If `true`, and [returnGeometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RelationshipQuery.html#returnGeometry) is `true`, then z-values are included in the geometry. */
+  accessor returnZ: boolean;
+  /**
+   * The zero-based index indicating where to begin retrieving features. This property should be used in conjunction with [num](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RelationshipQuery.html#num).
+   * Use this to implement paging and retrieve "pages" of results when querying. Features are sorted ascending by
+   * object ID by default.
+   */
+  accessor start: number;
+  /**
+   * The definition expression to be applied to the related table or layer. Only records in the list of [objectIds](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RelationshipQuery.html#objectIds)
+   * that satisfy the definition expression are queried for related records.
+   */
+  accessor where: string | null | undefined;
+  /**
+   * Creates a deep clone of RelationshipQuery object.
+   *
+   * @returns A new instance of a RelationshipQuery object equal to the object used to call `.clone()`.
+   * @since 4.7
+   */
+  clone(): RelationshipQuery;
+}

package/rest/support/RouteInfo.d.ts

@@ -1,4 +1,118 @@
-import "../../interfaces";
+import type Graphic from "../../Graphic.js";
+import type PopupTemplate from "../../PopupTemplate.js";
+import type Polyline from "../../geometry/Polyline.js";
+import type { ClonableMixin, ClonableMixinProperties } from "../../core/Clonable.js";
+import type { JSONSupport, JSONSupportMixinProperties } from "../../core/JSONSupport.js";
+import type { PolylineProperties } from "../../geometry/Polyline.js";
+import type { PopupTemplateProperties } from "../../PopupTemplate.js";
 
-import RouteInfo = __esri.RouteInfo;
-export default RouteInfo;
+export interface RouteInfoProperties extends JSONSupportMixinProperties, ClonableMixinProperties, Partial<Pick<RouteInfo, "endTimeOffset" | "name" | "startTimeOffset" | "totalDistance" | "totalDuration">> {
+  /** The end time of the route. */
+  endTime?: (Date | number | string) | null;
+  /** Polyline representing the route's geometry. */
+  geometry?: PolylineProperties | null;
+  /**
+   * The template for displaying content in a [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) when the graphic is selected.
+   *
+   * @since 4.30
+   */
+  popupTemplate?: PopupTemplateProperties | null;
+  /** The start time of the route. */
+  startTime?: (Date | number | string) | null;
+}
+
+/**
+ * A RouteInfo contains information about a solved route including the routes geometry and overall distance and time.
+ *
+ * @since 4.23
+ * @see [RouteParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html)
+ * @see [RouteLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html)
+ * @example
+ * // Display the route name and overall distance and duration.
+ * const routeLayer = new RouteLayer({
+ *   portalItem: {
+ *     id: "69569b47b1e445b8a42ec12feab41ce9"
+ *   }
+ * });
+ * await routeLayer.load();
+ *
+ * const locale = "en-US";
+ * const formatMinutes = new Intl.NumberFormat(locale, {
+ *   minimumFractionDigits: 1,
+ *   maximumFractionDigits: 1
+ * });
+ * const formatDistance = new Intl.NumberFormat(locale, {
+ *   minimumFractionDigits: 0,
+ *   maximumFractionDigits: 0
+ * });
+ * const formatDate = new Intl.DateTimeFormat(locale, {
+ *   year: 'numeric',
+ *   month: 'numeric',
+ *   day: 'numeric',
+ *   hour: 'numeric',
+ *   minute: 'numeric',
+ *   second: 'numeric',
+ *   timeZone: "America/Los_Angeles"
+ * });
+ *
+ * const { name, startTime, endTime, totalDistance, totalDuration } = routeLayer.routeInfo;
+ * console.log(`Route name:      ${name}`);
+ * console.log(`Start Time:      ${formatDate.format(startTime)}`);
+ * console.log(`End Time:        ${formatDate.format(endTime)}`);
+ * console.log(`Travel Time:     ${formatMinutes.format(totalDuration)} minutes`);
+ * console.log(`Travel Distance: ${formatDistance.format(totalDistance)} meters`);
+ *
+ * // Route name:      Kenoak Pl, Pomona, California, 91768 — 16561 Valley Blvd, Fontana, California, 92335
+ * // Start Time:      12/7/2020, 3:58:50 PM
+ * // End Time:        12/7/2020, 6:12:20 PM
+ * // Travel Time:     133.5 minutes
+ * // Travel Distance: 173,148 meters
+ */
+export default class RouteInfo extends RouteInfoSuperclass {
+  /**
+   * Creates a [RouteInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteInfo.html) from the parsed [Graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html).
+   * The method assumes that the graphic's attributes conform to the route layer item schema.
+   *
+   * @param graphic - A Graphic instance.
+   * @returns A RouteInfo instance.
+   * @since 4.24
+   */
+  static fromGraphic(graphic: Graphic): RouteInfo;
+  constructor(properties?: RouteInfoProperties);
+  /** The end time of the route. */
+  get endTime(): Date | null | undefined;
+  set endTime(value: (Date | number | string) | null | undefined);
+  /** The local time offset (in minutes) for the end time. */
+  accessor endTimeOffset: number | null | undefined;
+  /** Polyline representing the route's geometry. */
+  get geometry(): Polyline | null | undefined;
+  set geometry(value: PolylineProperties | null | undefined);
+  /** User specified route name. */
+  accessor name: string | null | undefined;
+  /**
+   * The template for displaying content in a [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) when the graphic is selected.
+   *
+   * @since 4.30
+   */
+  get popupTemplate(): PopupTemplate | null | undefined;
+  set popupTemplate(value: PopupTemplateProperties | null | undefined);
+  /** The start time of the route. */
+  get startTime(): Date | null | undefined;
+  set startTime(value: (Date | number | string) | null | undefined);
+  /** The local time offset (in minutes) for the start time. */
+  accessor startTimeOffset: number | null | undefined;
+  /** Total distance traveled in meters. */
+  accessor totalDistance: number | null | undefined;
+  /** Total time in minutes. */
+  accessor totalDuration: number | null | undefined;
+  get type(): "route-info";
+  /**
+   * Creates a [Graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) from the [RouteInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteInfo.html) instance.
+   * The resulting graphic will have attributes that conform to the route layer item schema.
+   *
+   * @returns A Graphic instance.
+   * @since 4.24
+   */
+  toGraphic(): Graphic;
+}
+declare const RouteInfoSuperclass: typeof JSONSupport & typeof ClonableMixin