@arcgis/core 5.0.0-next.70 → 5.0.0-next.72

package/rest/featureService/types.d.ts

@@ -7,93 +7,227 @@ import type { EditedFeatures, Edits, FeatureEditResult } from "../../layers/grap
 import type { AssociationJsonType } from "../../networks/support/typeUtils.js";
 import type { GeometryType } from "../support/types.js";
 
+/** @since 5.0 */
 export interface DataCapabilities {
-  /** Indicates if the feature service is branch versioned. */
+  /**
+   * Indicates if the feature service is branch versioned.
+   *
+   * @since 5.0
+   */
   isDataBranchVersioned: boolean;
-  /** Indicates if the feature service is versioned. */
+  /**
+   * Indicates if the feature service is versioned.
+   *
+   * @since 5.0
+   */
   isDataVersioned: boolean;
-  /** The types of true curves the service supports. */
+  /**
+   * The types of true curves the service supports.
+   *
+   * @since 5.0
+   */
   supportedCurveTypes: readonly CurveType[];
-  /** Indicates if the service supports geometries with true curves. */
+  /**
+   * Indicates if the service supports geometries with true curves.
+   *
+   * @since 5.0
+   */
   supportsTrueCurve: boolean;
 }
 
+/** @since 5.0 */
 export interface SyncDataOptions {
-  /** Indicates whether the full annotation model should be included in the sync data. */
+  /**
+   * Indicates whether the full annotation model should be included in the sync data.
+   *
+   * @since 5.0
+   */
   annotationFullModel: boolean;
-  /** Indicates whether annotations should be included in the sync data. */
+  /**
+   * Indicates whether annotations should be included in the sync data.
+   *
+   * @since 5.0
+   */
   annotations: boolean;
-  /** Indicates whether attribute rules should be included in the sync data. */
+  /**
+   * Indicates whether attribute rules should be included in the sync data.
+   *
+   * @since 5.0
+   */
   attributeRules: boolean;
-  /** Indicates whether contingent values should be included in the sync data. */
+  /**
+   * Indicates whether contingent values should be included in the sync data.
+   *
+   * @since 5.0
+   */
   contingentValues: boolean;
-  /** Indicates whether dimensions should be included in the sync data. */
+  /**
+   * Indicates whether dimensions should be included in the sync data.
+   *
+   * @since 5.0
+   */
   dimensions: boolean;
-  /** Indicates whether 3D objects should be included in the sync data. */
+  /**
+   * Indicates whether 3D objects should be included in the sync data.
+   *
+   * @since 5.0
+   */
   include3DObjects: boolean;
-  /** Indicates whether true curves should be preserved in the sync data. */
+  /**
+   * Indicates whether true curves should be preserved in the sync data.
+   *
+   * @since 5.0
+   */
   preserveTrueCurves: boolean;
-  /** Indicates whether missing utility network layers should be included in the sync data. */
+  /**
+   * Indicates whether missing utility network layers should be included in the sync data.
+   *
+   * @since 5.0
+   */
   utilityNetworkMissingLayers: boolean;
-  /** Indicates whether the utility network system should be included in the sync data. */
+  /**
+   * Indicates whether the utility network system should be included in the sync data.
+   *
+   * @since 5.0
+   */
   utilityNetworkSystem: boolean;
 }
 
+/** @since 5.0 */
 export interface SyncCapabilities {
-  /** Indicates the supported sync data options for the service */
+  /**
+   * Indicates the supported sync data options for the service
+   *
+   * @since 5.0
+   */
   supportedSyncDataOptions: SyncDataOptions;
-  /** Indicates whether the service supports asynchronous synchronization. */
+  /**
+   * Indicates whether the service supports asynchronous synchronization.
+   *
+   * @since 5.0
+   */
   supportsAsync: boolean;
 }
 
+/** @since 5.0 */
 export interface OperationCapabilities {
-  /** Indicates if new features can be [added](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#applyEdits) to the service. */
+  /**
+   * Indicates if new features can be [added](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#applyEdits) to the service.
+   *
+   * @since 5.0
+   */
   supportsAdd: boolean;
-  /** Indicates whether the service supports change tracking for features. */
+  /**
+   * Indicates whether the service supports change tracking for features.
+   *
+   * @since 5.0
+   */
   supportsChangeTracking: boolean;
-  /** Indicates if features can be [deleted](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#applyEdits) from the service. */
+  /**
+   * Indicates if features can be [deleted](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#applyEdits) from the service.
+   *
+   * @since 5.0
+   */
   supportsDelete: boolean;
   /**
    * Indicates if features in the service can be [edited](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#applyEdits).
    *  Use `supportsAdd`, `supportsUpdate` and `supportsDelete` to determine which editing operations are supported.
+   *
+   * @since 5.0
    */
   supportsEditing: boolean;
-  /** Indicates if features in the service can be {@link rest/featureService/FeatureService#queryFeatures queried}. */
+  /**
+   * Indicates if features in the service can be queried.
+   *
+   * @since 5.0
+   */
   supportsQuery: boolean;
-  /** Indicates whether the service supports querying contingent values. */
+  /**
+   * Indicates whether the service supports querying contingent values.
+   *
+   * @since 5.0
+   */
   supportsQueryContingentValues: boolean;
-  /** Indicates whether the service supports querying data elements. */
+  /**
+   * Indicates whether the service supports querying data elements.
+   *
+   * @since 5.0
+   */
   supportsQueryDataElements: boolean;
-  /** Indicates whether the service supports querying domains. */
+  /**
+   * Indicates whether the service supports querying domains.
+   *
+   * @since 5.0
+   */
   supportsQueryDomains: boolean;
-  /** Indicates whether the service supports synchronization. */
+  /**
+   * Indicates whether the service supports synchronization.
+   *
+   * @since 5.0
+   */
   supportsSync: boolean;
-  /** Indicates whether the service supports updating features. */
+  /**
+   * Indicates whether the service supports updating features.
+   *
+   * @since 5.0
+   */
   supportsUpdate: boolean;
 }
 
+/** @since 5.0 */
 export interface QueryCapabilities {
-  /** The maximum number of records that will be returned for a given query. */
+  /**
+   * The maximum number of records that will be returned for a given query.
+   *
+   * @since 5.0
+   */
   maxRecordCount?: number | null;
-  /** This property is used to limit the number of records returned based on a factor of the `query.maxRecordCount`. */
+  /**
+   * This property is used to limit the number of records returned based on a factor of the `query.maxRecordCount`.
+   *
+   * @since 5.0
+   */
   maxRecordCountFactor?: number | null;
 }
 
+/** @since 5.0 */
 export interface EditingCapabilities {
-  /** Indicates if the service supports async apply edits. */
+  /**
+   * Indicates if the service supports async apply edits.
+   *
+   * @since 5.0
+   */
   supportsAsyncApplyEdits: boolean;
-  /** Indicates if the `globalId` values provided by the client are used in [FeatureService#applyEdits()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#applyEdits). */
+  /**
+   * Indicates if the `globalId` values provided by the client are used in [FeatureService#applyEdits()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#applyEdits).
+   *
+   * @since 5.0
+   */
   supportsGlobalId: boolean;
-  /** Indicates that the service supports returning edits in the source spatial reference of the layer they belong to. */
+  /**
+   * Indicates that the service supports returning edits in the source spatial reference of the layer they belong to.
+   *
+   * @since 5.0
+   */
   supportsReturnServiceEditsInSourceSpatialReference: boolean;
-  /** Indicates whether the service supports splitting features. */
+  /**
+   * Indicates whether the service supports splitting features.
+   *
+   * @since 5.0
+   */
   supportsSplit: boolean;
-  /** Indicates if feature geometries containing true curves can be updated. */
+  /**
+   * Indicates if feature geometries containing true curves can be updated.
+   *
+   * @since 5.0
+   */
   supportsTrueCurveUpdate: boolean;
   /**
    * Indicates whether updates to true curves should be restricted to clients
    * that support true editing. If `true`, `applyEdits` calls that update true
    * curves must have the `trueCurveClient` parameter set to `true`.
+   *
+   * @since 5.0
    */
   supportsTrueCurveUpdateByTrueCurveClientsOnly: boolean;
 }
@@ -104,30 +238,56 @@ export interface EditingCapabilities {
  * @since 4.28
  */
 export interface ServiceCapabilities {
-  /** Describes characteristics of the data in the service. */
+  /**
+   * Describes characteristics of the data in the service.
+   *
+   * @since 5.0
+   */
   data: DataCapabilities;
-  /** Describes editing capabilities that can be performed on the features in the layer via [FeatureService#applyEdits()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#applyEdits). */
+  /**
+   * Describes editing capabilities that can be performed on the features in the layer via [FeatureService#applyEdits()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html#applyEdits).
+   *
+   * @since 5.0
+   */
   editing: EditingCapabilities;
-  /** Describes operations that can be performed on features in the layer. */
+  /**
+   * Describes operations that can be performed on features in the layer.
+   *
+   * @since 5.0
+   */
   operations: OperationCapabilities;
   /**
    * Describes [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html)
    * operations that can be performed on the Feature Service.
+   *
+   * @since 5.0
    */
   query: QueryCapabilities;
-  /** Describes the synchronization capabilities of a service. */
+  /**
+   * Describes the synchronization capabilities of a service.
+   *
+   * @since 5.0
+   */
   sync: SyncCapabilities;
 }
 
 /**
- * Results returned from the {@link rest/featureService/interfaces#createFeatureService} method.
+ * Results returned from the [createFeatureServices()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-utils.html#createFeatureServices) method.
  *
  * @since 4.28
  */
 export interface FeatureServiceResourcesBundle {
-  /** Returns a featureService object. */
+  /**
+   * Returns a featureService object.
+   *
+   * @since 5.0
+   */
   featureService: FeatureService;
-  /** An array of [FeatureLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) */
+  /**
+   * An array of [FeatureLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html)
+   *
+   * @since 5.0
+   */
   layers: (FeatureLayer | SubtypeGroupLayer)[];
 }
 
@@ -137,13 +297,29 @@ export interface FeatureServiceResourcesBundle {
  * @since 4.30
  */
 export interface TableInfo {
-  /** The id of a table. */
+  /**
+   * The id of a table.
+   *
+   * @since 5.0
+   */
   id: number;
-  /** The name of a table. */
+  /**
+   * The name of a table.
+   *
+   * @since 5.0
+   */
   name: string;
-  /** The type of the table. */
+  /**
+   * The type of the table.
+   *
+   * @since 5.0
+   */
   type: string;
-  /** The service url */
+  /**
+   * The service url
+   *
+   * @since 5.0
+   */
   url: string;
 }
 
@@ -153,7 +329,11 @@ export interface TableInfo {
  * @since 4.30
  */
 export interface LayerInfo extends TableInfo {
-  /** The geometry type of a layer. */
+  /**
+   * The geometry type of a layer.
+   *
+   * @since 5.0
+   */
   geometryType?: GeometryType;
 }
 
@@ -163,7 +343,11 @@ export interface LayerInfo extends TableInfo {
  * @since 4.30
  */
 export interface LayerDefinition extends LayerInfo {
-  /** The capabilities of the layer. */
+  /**
+   * The capabilities of the layer.
+   *
+   * @since 5.0
+   */
   capabilities: FeatureLayerCapabilities;
 }
 
@@ -173,7 +357,11 @@ export interface LayerDefinition extends LayerInfo {
  * @since 4.30
  */
 export interface TableDefinition extends TableInfo {
-  /** The capabilities of the table. */
+  /**
+   * The capabilities of the table.
+   *
+   * @since 5.0
+   */
   capabilities: FeatureLayerCapabilities;
 }
 
@@ -183,9 +371,17 @@ export interface TableDefinition extends TableInfo {
  * @since 4.30
  */
 export interface ServiceContents {
-  /** Contains the Layer Definition of a layer. */
+  /**
+   * Contains the Layer Definition of a layer.
+   *
+   * @since 5.0
+   */
   layers: LayerDefinition[];
-  /** Contains the Table Definition of a layer. */
+  /**
+   * Contains the Table Definition of a layer.
+   *
+   * @since 5.0
+   */
   tables: TableDefinition[];
 }
 
@@ -197,21 +393,53 @@ export interface ServiceContents {
  * @since 4.34
  */
 export interface DeleteAssociationEdit {
-  /** The type of association. */
+  /**
+   * The type of association.
+   *
+   * @since 5.0
+   */
   associationType: AssociationJsonType;
-  /** The global ID of the "from" feature. */
+  /**
+   * The global ID of the "from" feature.
+   *
+   * @since 5.0
+   */
   fromGlobalId: string;
-  /** The source ID of the "from" feature. */
+  /**
+   * The source ID of the "from" feature.
+   *
+   * @since 5.0
+   */
   fromSourceId: number;
-  /** The terminal ID of the "from" feature. */
+  /**
+   * The terminal ID of the "from" feature.
+   *
+   * @since 5.0
+   */
   fromTerminalId: number;
-  /** The global ID of the association to delete. */
+  /**
+   * The global ID of the association to delete.
+   *
+   * @since 5.0
+   */
   globalId: string;
-  /** The global ID of the "to" feature. */
+  /**
+   * The global ID of the "to" feature.
+   *
+   * @since 5.0
+   */
   toGlobalId: string;
-  /** The source ID of the "to" feature. */
+  /**
+   * The source ID of the "to" feature.
+   *
+   * @since 5.0
+   */
   toSourceId: number;
-  /** The terminal ID of the "to" feature. */
+  /**
+   * The terminal ID of the "to" feature.
+   *
+   * @since 5.0
+   */
   toTerminalId: number;
 }
 
@@ -226,6 +454,8 @@ export interface CombineGroupedObjectsEdit {
    * The global IDs of the grouped features to combine.
    *   The objects being combined must have consecutive unit IDs, exist in the same table and unit container,
    *   and have the same attribute values.
+   *
+   * @since 5.0
    */
   globalIds: string[];
 }
@@ -237,12 +467,18 @@ export interface CombineGroupedObjectsEdit {
  * @since 4.34
  */
 export interface DivideGroupedObjectsEdit {
-  /** The global ID of the grouped object to divide. */
+  /**
+   * The global ID of the grouped object to divide.
+   *
+   * @since 5.0
+   */
   globalId: string;
   /**
    * The units to divide the grouped object into.
    *   Each number in this array describes the number of units to assign an object resulting from the division.
    *   E.g., to divide one object with 6 units into an object with 5 units and another object with 1 unit, specify `[5, 1]`.
+   *
+   * @since 5.0
    */
   numUnits: number[];
 }
@@ -258,41 +494,67 @@ export interface ServiceEdits extends Edits {
    * An array of objects specifying
    *   grouped objects to combine in a telecom domain network. The objects being combined must have consecutive unit IDs, exist in the same table and unit container,
    *   and have the same attribute values.
+   *
+   * @since 5.0
    */
   combineGroupedObjects?: CombineGroupedObjectsEdit[];
   /**
    * An array of objects specifying
    *   traditional or foreign-key associations to delete. To delete associations with `deleteAssociations`, all "from" and "to" properties must
    *   be specified in the [DeleteAssociationEdit](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-types.html#DeleteAssociationEdit) object.
+   *
+   * @since 5.0
    */
   deleteAssociations?: DeleteAssociationEdit[];
   /**
    * An array of objects specifying
    *   a grouped objects to divide, and the units to divide the objects into, in a telecom domain network.
+   *
+   * @since 5.0
    */
   divideGroupedObjects?: DivideGroupedObjectsEdit[];
-  /** The layerId of the feature layer. */
+  /**
+   * The layerId of the feature layer.
+   *
+   * @since 5.0
+   */
   id: number;
-  /** Identifier for globalId and objectId. */
+  /**
+   * Identifier for globalId and objectId.
+   *
+   * @since 5.0
+   */
   identifierFields?: ServiceEditsIdentifierFields;
 }
 
+/** @since 5.0 */
 export interface ServiceEditsIdentifierFields {
-  /** The globalId identifier. */
+  /**
+   * The globalId identifier.
+   *
+   * @since 5.0
+   */
   globalIdField?: string | null;
-  /** The objectId identifier. */
+  /**
+   * The objectId identifier.
+   *
+   * @since 5.0
+   */
   objectIdField: string;
 }
 
+/** @since 5.0 */
 export interface ServiceEditOptions {
   /**
    * The geodatabase version to apply the edits. This parameter applies only if the
-   * {@link rest/featureService/interfaces#capabilities capabilities.data.isDataVersioned} property of the layer is `true`.
+   * [capabilities.data.isDataVersioned](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-types.html#DataCapabilities) property of the layer is `true`.
+   *
+   * @since 5.0
    */
   gdbVersion?: string;
   /**
    * Indicates whether the edits can be applied using globalIds of features or attachments.
-   * This parameter applies only if the layer's {@link rest/featureService/interfaces#capabilities capabilities.editing.supportsGlobalId} property is `true`.
+   * This parameter applies only if the layer's [capabilities.editing.supportsGlobalId](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-types.html#EditingCapabilities) property is `true`.
    * When `false`, globalIds submitted with the features are ignored and the service assigns new globalIds
    * to the new features. When `true`, the globalIds must be submitted with the new features. When updating existing features, if the `globalIdUsed` is
    * `false`, the objectIds of the features to be updated must be provided. If the `globalIdUsed` is `true`, globalIds of features to be updated must be provided.
@@ -301,6 +563,8 @@ export interface ServiceEditOptions {
    * When adding, updating or deleting attachments, `globalIdUsed` parameter must be set to `true` and the attachment globalId must be set.
    * For new attachments, the user must provide globalIds. In order for an attachment to be updated or deleted, clients must include its globalId.
    * Attachments are not supported in an edit payload when `globalIdUsed` is `false`.
+   *
+   * @since 5.0
    */
   globalIdUsed?: boolean;
   /**
@@ -308,12 +572,16 @@ export interface ServiceEditOptions {
    * This parameter specifies whether to apply edits in the order they are submitted in the JSON.
    * If true, edits will apply in the submitted order. If false, which is the default, edits will apply in ascending layer-ID order.
    * All the edits for the layer with the lowest ID will apply first.
+   *
+   * @since 5.0
    */
   honorSequenceOfEdits?: boolean;
   /**
    * Indicates to the server whether the client is true curve capable.
    * This parameter should be set to `true` when submitting edits with geometries containing true curves for non-hosted feature services referencing an enterprise geodatabase.
    * By default, this parameter is set to false.
+   *
+   * @since 5.0
    */
   trueCurveClient?: boolean;
   /**
@@ -322,6 +590,8 @@ export interface ServiceEditOptions {
    * This allows an editor to apply a single block of edits partially, complete another task, and then complete the block of edits.
    *  When set to true, the edits are applied with the same edit moment as the previous sets of edits.
    * When set to false the edits are applied with a new edit moment. By default, this parameter is set to false.
+   *
+   * @since 5.0
    */
   usePreviousEditMoment?: boolean;
 }
@@ -338,14 +608,22 @@ export interface DivideGroupedObjectResult {
    *   to one or more edge objects prior to the division, the edge objects are also divided to maintain connectivity.
    *   This array contains GUIDs of any edge objects that are connected to the divided junction objects,
    *   including those that were connected prior to the division.
+   *
+   * @since 5.0
    */
   connectedEdgeGlobalIds: string[];
   /**
    * The global IDs of objects resulting from the division, including the original object.
    *   I.e., the GUIDs that the target object was divided into.
+   *
+   * @since 5.0
    */
   dividedGlobalIds: string[];
-  /** Global ID of the original object before division. */
+  /**
+   * Global ID of the original object before division.
+   *
+   * @since 5.0
+   */
   globalId: string;
 }
 
@@ -356,9 +634,17 @@ export interface DivideGroupedObjectResult {
  * @since 4.34
  */
 export interface CombineGroupedObjectResult {
-  /** The global ID of the object resulting from the combine operation. */
+  /**
+   * The global ID of the object resulting from the combine operation.
+   *
+   * @since 5.0
+   */
   combinedGlobalId: string;
-  /** The global IDs of the objects deleted to perform the combination. */
+  /**
+   * The global IDs of the objects deleted to perform the combination.
+   *
+   * @since 5.0
+   */
   deletedGlobalIds: string[];
 }
 
@@ -369,36 +655,96 @@ export interface CombineGroupedObjectResult {
  * @since 4.28
  */
 export interface ServiceEditsResult {
-  /** Results returned from an add attachments operation. */
+  /**
+   * Results returned from an add attachments operation.
+   *
+   * @since 5.0
+   */
   addAttachmentResults: FeatureEditResult[];
-  /** Results returned from an add operation. */
+  /**
+   * Results returned from an add operation.
+   *
+   * @since 5.0
+   */
   addFeatureResults: FeatureEditResult[];
-  /** Results returned from a combine operation. */
+  /**
+   * Results returned from a combine operation.
+   *
+   * @since 5.0
+   */
   combineGroupedObjectResults?: CombineGroupedObjectResult[];
-  /** Results returned from a delete attachments operation. */
+  /**
+   * Results returned from a delete attachments operation.
+   *
+   * @since 5.0
+   */
   deleteAttachmentResults: FeatureEditResult[];
-  /** Results returned from a delete operation. */
+  /**
+   * Results returned from a delete operation.
+   *
+   * @since 5.0
+   */
   deleteFeatureResults: FeatureEditResult[];
-  /** Results returned from a divide operation. */
+  /**
+   * Results returned from a divide operation.
+   *
+   * @since 5.0
+   */
   divideGroupedObjectResults?: DivideGroupedObjectResult[];
-  /** Object containing all edited features belonging to the specified layer. */
+  /**
+   * Object containing all edited features belonging to the specified layer.
+   *
+   * @since 5.0
+   */
   editedFeatures?: EditedFeatures;
-  /** Returns the editMoment of an edit. */
+  /**
+   * Returns the editMoment of an edit.
+   *
+   * @since 5.0
+   */
   editMoment?: number;
-  /** The layerId of the feature layer where features were edited. */
+  /**
+   * The layerId of the feature layer where features were edited.
+   *
+   * @since 5.0
+   */
   id: number;
-  /** Results returned from a split operation. */
+  /**
+   * Results returned from a split operation.
+   *
+   * @since 5.0
+   */
   splitsResults?: SplitsResult[];
-  /** Results returned from an update attachments operation. */
+  /**
+   * Results returned from an update attachments operation.
+   *
+   * @since 5.0
+   */
   updateAttachmentResults: FeatureEditResult[];
-  /** Results returned from an update operation. */
+  /**
+   * Results returned from an update operation.
+   *
+   * @since 5.0
+   */
   updateFeatureResults: FeatureEditResult[];
 }
 
-/** Represents the result of a split operation. */
+/**
+ * Represents the result of a split operation.
+ *
+ * @since 5.0
+ */
 export interface SplitsResult {
-  /** The object ID of the feature that was split. */
+  /**
+   * The object ID of the feature that was split.
+   *
+   * @since 5.0
+   */
   objectId: number;
-  /** The object ID of the original feature and the feature(s) created from the split. */
+  /**
+   * The object ID of the original feature and the feature(s) created from the split.
+   *
+   * @since 5.0
+   */
   results: number[];
 }