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

package/editing/types.d.ts

@@ -2,6 +2,8 @@ import type SharedTemplate from "./sharedTemplates/SharedTemplate.js";
 import type SharedTemplateMetadata from "./sharedTemplates/SharedTemplateMetadata.js";
 import type FeatureTemplate from "../layers/support/FeatureTemplate.js";
 
+/** @since 5.0 */
 export type AnyEditingTemplateInfo = FeatureTemplate | SharedTemplateMetadata;
 
+/** @since 5.0 */
 export type AnyEditingTemplate = FeatureTemplate | SharedTemplate;

package/effects/types.d.ts

@@ -1,2 +1,3 @@
 
+/** @since 5.0 */
 export type FocusAreaStyle = "bright" | "dark";

package/form/ExpressionInfo.d.ts

@@ -4,7 +4,7 @@ import type { FormExpressionReturnType } from "../portal/jsonTypes.js";
 export interface ExpressionInfoProperties extends JSONSupportMixinProperties, Partial<Pick<ExpressionInfo, "expression" | "name" | "returnType" | "title">> {}
 
 /**
- * The `ExpressionInfo` class defines the makeup of [visibility expressions](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-FieldElement.html#visibilityExpression), [required expressions](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-FieldElement.html#requiredExpression), [editable expressions](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-FieldElement.html#editableExpression), and [value expressions](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-FieldElement.html#valueExpression). [Visibility expressions](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-FieldElement.html#visibilityExpression) are available on [field](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-FieldElement.html), [group](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-GroupElement.html), and [relationship](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-RelationshipElement.html) elements. These [FormTemplate#elements](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-FormTemplate.html#elements) are contained within a `formTemplate` set directly on either a {@link widgets/FeatureForm#featureTemplate} or {@link layers/FeatureLayer#featureTemplate}.
+ * The `ExpressionInfo` class defines the makeup of [visibility expressions](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-FieldElement.html#visibilityExpression), [required expressions](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-FieldElement.html#requiredExpression), [editable expressions](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-FieldElement.html#editableExpression), and [value expressions](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-FieldElement.html#valueExpression). [Visibility expressions](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-FieldElement.html#visibilityExpression) are available on [field](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-FieldElement.html), [group](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-GroupElement.html), and [relationship](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-RelationshipElement.html) elements. These [FormTemplate#elements](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-FormTemplate.html#elements) are contained within a `formTemplate` set directly on either a [FeatureForm#formTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html#formTemplate) or [FeatureLayer#formTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#formTemplate).
  *
  * All of the [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expressions referenced above, excluding [value expressions](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-FieldElement.html#valueExpression), must follow the specification defined in the [Form Constraint Profile](https://developers.arcgis.com/javascript/latest/arcade/#forms). This profile may reference field values using the `$feature` variable and the expression must return `true` or `false`.
  *

package/form/FormTemplate.d.ts

@@ -89,8 +89,8 @@ export interface FormTemplateProperties extends JSONSupportMixinProperties, Part
 
 /**
  * A `FormTemplate` formats and defines the content of a [FeatureForm](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html) for
- * a specific [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) or {@link layers/support/SubtypeSubLayer}.
- * The `FormTemplate` allows the user to create and update feature attribute values which can be set directly on a [FeatureLayer#formTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#formTemplate), {@link layers/support/SubtypeSubLayer#formTemplate},a [FeatureForm#formTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html#formTemplate), a [FeatureForm view model](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FeatureFormViewModel.html#formTemplate), or within the [Editor's layerInfos](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#layerInfos).
+ * a specific [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) or [SubtypeSublayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html).
+ * The `FormTemplate` allows the user to create and update feature attribute values which can be set directly on a [FeatureLayer#formTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#formTemplate), [SubtypeSublayer#formTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html#formTemplate),a [FeatureForm#formTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html#formTemplate), a [FeatureForm view model](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm-FeatureFormViewModel.html#formTemplate), or within the [Editor's layerInfos](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html#layerInfos).
  * The `FormTemplate` is composed of various [elements](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-FormTemplate.html#elements) that display a specific type of form data. Each element is designed to allow the form author the ability to define the layout for fields when collecting and/or editing data.
  *
  * Forms can be created with a variety of elements, including:
@@ -283,7 +283,7 @@ export default class FormTemplate extends JSONSupport {
    *
    * >
    * > Below is a comprehensive list of all the possible ways in which a field can be utilized within a `FormTemplate`:
-   * > The `FormTemplate` contains a {@link form/elements/FieldElements field element} associated with the field.
+   * > The `FormTemplate` contains a [field element](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-FieldElement.html) associated with the field.
    * > The field is identified by the [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) parser as being referenced in an [ExpressionInfo#expression](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-ExpressionInfo.html#expression) that is used by one (or more) of the elements in the
    * > `FormTemplate`. **Take note that expressions included in [ExpressionInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-ExpressionInfo.html) but not used by any of the elements are not considered.**
    * > The field is referenced via a template string, ie.`{}`, substitution syntax in the [title](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-FormTemplate.html#title) or [description](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-FormTemplate.html#description) properties of the `FormTemplate`.
@@ -291,7 +291,7 @@ export default class FormTemplate extends JSONSupport {
    * > The `FormTemplate` contains [TextElement#text](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-TextElement.html#text) that references the field via a template string, ie.`{}`, substitution syntax.
    * > The form contains a [RelationshipElement](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-RelationshipElement.html) that uses the field to order results, as specified in its [RelationshipElement#orderByFields](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-RelationshipElement.html#orderByFields) property.
    * > The field serves as a relationship key field for a relationship that is represented by a [RelationshipElement](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-RelationshipElement.html) in the `FormTemplate`. These fields will be included in the output _only_ if a value is provided for the relationship parameter. **The `FormTemplate` by itself does not possess enough information to determine the key field of a relationship.**
-   * > The `FormTemplate` contains {@link form/elements/UtilityNetworkAssociationsElement#title} or [UtilityNetworkAssociationsElement#description](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-UtilityNetworkAssociationsElement.html#description)` that references the field via a template string, ie.`{}`, substitution syntax.
+   * > The `FormTemplate` contains [UtilityNetworkAssociationsElement#label](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-UtilityNetworkAssociationsElement.html#label) or [UtilityNetworkAssociationsElement#description](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-UtilityNetworkAssociationsElement.html#description) that references the field via a template string, ie.`{}`, substitution syntax.
    *
    * @param fieldsIndex - The field index. It can be used to make
    * case-insensitive lookup by name for fields used in the `FormTemplate`.

package/form/elements/GroupElement.d.ts

@@ -46,7 +46,7 @@ export interface GroupElementProperties extends ElementProperties, Partial<Pick<
  * > [!WARNING]
  * >
  * > Nested group elements are not supported.
- * > A group element must be visible if it contains a {@link form/elements/FieldElement#required} field.
+ * > A group element must be visible if it contains a [required](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-FieldElement.html#requiredExpression) field.
  *
  * @since 4.16
  * @see [FormTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-FormTemplate.html)

package/form/elements/RelationshipElement.d.ts

@@ -21,9 +21,9 @@ export interface RelationshipElementProperties extends ElementProperties, Partia
  * > Support is limited to 1:1 and 1:M cardinality.
  * > Support is limited to feature-to-table and feature-to-feature relationships, ie. origin-to-destination. The origin's entry point must be a feature with geometry.
  * > Relationship editing is only supported using ArcGIS Online and ArcGIS Enterprise version 11.2 or higher feature services.
- * > The layer and associated {@link form/elements/Relationship relationship elements} must be editable in order for the relationship to display.
- * > Data containing related records will display the relationship in the associated form as long as there is a {@link form/elements/Relationship relationship element} configured in the [layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#formTemplate) or [form's](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html#formTemplate) formTemplate. This can be accomplished via the Map Viewer's [authoring experience](https://doc.arcgis.com/en/arcgis-online/create-maps/create-form-mv.htm), [Field Maps Designer](https://learn.arcgis.com/en/projects/build-a-form-with-field-maps-designer), or programmatically using the API.
- * > The related layer or table must also be added to the map to be able to configure {@link form/elements/Relationship relationship elements}.
+ * > The layer and associated [relationship elements](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-RelationshipElement.html) must be editable in order for the relationship to display.
+ * > Data containing related records will display the relationship in the associated form as long as there is a [relationship element](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-RelationshipElement.html) configured in the [layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#formTemplate) or [form's](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html#formTemplate) formTemplate. This can be accomplished via the Map Viewer's [authoring experience](https://doc.arcgis.com/en/arcgis-online/create-maps/create-form-mv.htm), [Field Maps Designer](https://learn.arcgis.com/en/projects/build-a-form-with-field-maps-designer), or programmatically using the API.
+ * > The related layer or table must also be added to the map to be able to configure [relationship elements](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-RelationshipElement.html).
  * > Relationship editing on layers with preset and group templates are not yet supported.
  *
  * @since 4.27

package/form/elements/inputs/attachments/AttachmentInput.d.ts

@@ -41,7 +41,7 @@ export interface AttachmentInputProperties extends Partial<Pick<AttachmentInput,
  *
  * @experimental
  * @since 4.31
- * @see {@link form/elements/inputs/attachments/AttachmentElement}
+ * @see [AttachmentElement](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-AttachmentElement.html)
  * @example
  * // Creates a new AttachmentInput for an attachment element within a form
  * const attachmentInput = new AttachmentInput({
@@ -103,6 +103,7 @@ export default class AttachmentInput extends Input {
    *
    * @default "attachment"
    * @experimental
+   * @since 5.0
    */
   get type(): "attachment";
 }

package/form/elements/inputs/attachments/AudioInput.d.ts

@@ -42,6 +42,7 @@ export default class AudioInput extends Input {
    *
    * @default "audio"
    * @experimental
+   * @since 5.0
    */
   get type(): "audio";
 }

package/form/elements/inputs/attachments/DocumentInput.d.ts

@@ -33,6 +33,7 @@ export default class DocumentInput extends Input {
    *
    * @default "document"
    * @experimental
+   * @since 5.0
    */
   get type(): "document";
 }

package/form/elements/inputs/attachments/ImageInput.d.ts

@@ -42,6 +42,7 @@ export default class ImageInput extends Input {
    *
    * @default "image"
    * @experimental
+   * @since 5.0
    */
   get type(): "image";
 }

package/form/elements/inputs/attachments/Input.d.ts

@@ -2,7 +2,10 @@ import type { ClonableMixin } from "../../../../core/Clonable.js";
 import type { JSONSupport } from "../../../../core/JSONSupport.js";
 import type { AttachmentInputType } from "./types.js";
 
-/** @experimental */
+/**
+ * @since 5.0
+ * @experimental
+ */
 export default abstract class Input extends InputSuperclass {
   /**
    * The type of [input](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-AttachmentElement.html#input) used in [attachment elements](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-AttachmentElement.html). These elements are set within a [feature layer's](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#formTemplate) or [form's](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html#formTemplate) `formTemplate`. The configured `formTemplate` automatically displays within the [Editor](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor.html) widget when editing attribute features.
@@ -16,6 +19,7 @@ export default abstract class Input extends InputSuperclass {
    * signature | The user interface for a [signature](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-attachments-SignatureInput.html) input.
    * video | The user interface for a [video](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-attachments-VideoInput.html) input.
    *
+   * @since 5.0
    * @experimental
    */
   get type(): AttachmentInputType | null;

package/form/elements/inputs/attachments/SignatureInput.d.ts

@@ -35,6 +35,7 @@ export default class SignatureInput extends Input {
    *
    * @default "signature"
    * @experimental
+   * @since 5.0
    */
   get type(): "signature";
 }

package/form/elements/inputs/attachments/VideoInput.d.ts

@@ -42,6 +42,7 @@ export default class VideoInput extends Input {
    *
    * @default "video"
    * @experimental
+   * @since 5.0
    */
   get type(): "video";
 }

package/form/elements/inputs/attachments/types.d.ts

@@ -5,11 +5,20 @@ import type ImageInput from "./ImageInput.js";
 import type SignatureInput from "./SignatureInput.js";
 import type VideoInput from "./VideoInput.js";
 
-/** @experimental */
+/**
+ * @since 5.0
+ * @experimental
+ */
 export type AttachmentInputUnion = AttachmentInput | AudioInput | DocumentInput | ImageInput | SignatureInput | VideoInput;
 
-/** @experimental */
+/**
+ * @since 5.0
+ * @experimental
+ */
 export type AttachmentInputType = AttachmentInputUnion["type"];
 
-/** @experimental */
+/**
+ * @since 5.0
+ * @experimental
+ */
 export type NestableAttachmentInputUnion = Exclude<AttachmentInputUnion, AttachmentInput>;

package/form/elements/inputs.d.ts

@@ -67,10 +67,10 @@ import type TimePickerInputClass from "./inputs/TimePickerInput.js";
 /** Form element input types. */
 export type Input = BarcodeScannerInputClass | ComboBoxInputClass | DatePickerInputClass | DateTimeOffsetPickerInputClass | DateTimePickerInputClass | RadioButtonsInputClass | SwitchInputClass | TextAreaInputClass | TextBoxInputClass | TimePickerInputClass;
 
-/** The `BarcodeScannerInput` class defines the desired user interface is a barcode or QR code scanner. If this type is used in an ArcGIS Maps SDK for JavaScript web application, it will default to the {@link form/elements/inputs/TexBoxInput} type as the API does not support bar code scanning as an input type. */
+/** The `BarcodeScannerInput` class defines the desired user interface is a barcode or QR code scanner. If this type is used in an ArcGIS Maps SDK for JavaScript web application, it will default to the [TextBoxInput](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-TextBoxInput.html) type as the API does not support bar code scanning as an input type. */
 export const BarcodeScannerInput: typeof BarcodeScannerInputClass;
 
-/** The `BarcodeScannerInput` class defines the desired user interface is a barcode or QR code scanner. If this type is used in an ArcGIS Maps SDK for JavaScript web application, it will default to the {@link form/elements/inputs/TexBoxInput} type as the API does not support bar code scanning as an input type. */
+/** The `BarcodeScannerInput` class defines the desired user interface is a barcode or QR code scanner. If this type is used in an ArcGIS Maps SDK for JavaScript web application, it will default to the [TextBoxInput](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-TextBoxInput.html) type as the API does not support bar code scanning as an input type. */
 export type BarcodeScannerInput = BarcodeScannerInputClass;
 
 /** The `ComboBoxInput` class defines the desired user interface for a combo box group. */

package/form/types.d.ts

@@ -11,7 +11,10 @@ import type UtilityNetworkAssociationsElement from "./elements/UtilityNetworkAss
  * > [!CAUTION]
  * >
  * > The `AttachmentElement` is not yet fully supported within the SDK and is not intended for use in development. Support will be added in an upcoming release.
+ *
+ * @since 5.0
  */
 export type FormElementUnion = AttachmentElement | FieldElement | GroupElement | RelationshipElement | TextElement | UtilityNetworkAssociationsElement;
 
+/** @since 5.0 */
 export type NestableFormElementUnion = Exclude<FormElementUnion, GroupElement>;

package/geometry/geometryEngineTypes.d.ts

@@ -7,6 +7,7 @@
  * [here](https://resources.arcgis.com/en/help/arcobjects-cpp/componenthelp/index.html#/esriSRUnit2Type_Constants/000w00000041000000/).
  *
  * @deprecated since version 4.32. Use [LengthUnit](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-units.html#LengthUnit) instead.
+ * @since 5.0
  */
 export type LinearUnit = "feet" | "kilometers" | "meters" | "miles" | "nautical-miles" | "yards";
 
@@ -18,6 +19,7 @@ export type LinearUnit = "feet" | "kilometers" | "meters" | "miles" | "nautical-
  * [here](https://resources.arcgis.com/en/help/arcobjects-cpp/componenthelp/index.html#/esriSRUnit2Type_Constants/000w00000041000000/).
  *
  * @deprecated since version 4.32. Use [AreaUnit](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-units.html#AreaUnit) instead.
+ * @since 5.0
  */
 export type AreaUnit = "acres" | "ares" | "hectares" | "square-feet" | "square-kilometers" | "square-meters" | "square-miles" | "square-yards";
 
@@ -27,18 +29,39 @@ export type AreaUnit = "acres" | "ares" | "hectares" | "square-feet" | "square-k
  * method.
  *
  * @deprecated since version 4.32.
+ * @since 5.0
  * @see [extendedSpatialReferenceInfo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#extendedSpatialReferenceInfo)
  */
 export interface ExtendedSpatialReferenceInfo {
-  /** The XY tolerance of the spatial reference. */
+  /**
+   * The XY tolerance of the spatial reference.
+   *
+   * @since 5.0
+   */
   tolerance: number;
-  /** Base factor. */
+  /**
+   * Base factor.
+   *
+   * @since 5.0
+   */
   unitBaseFactor: number;
-  /** Unit ID. */
+  /**
+   * Unit ID.
+   *
+   * @since 5.0
+   */
   unitID: number;
-  /** Square derivative. */
+  /**
+   * Square derivative.
+   *
+   * @since 5.0
+   */
   unitSquareDerivative: number;
-  /** Unit type. */
+  /**
+   * Unit type.
+   *
+   * @since 5.0
+   */
   unitType: number;
 }
 
@@ -46,14 +69,31 @@ export interface ExtendedSpatialReferenceInfo {
  * Object returned from the [nearestCoordinate()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#nearestCoordinate), [nearestVertex()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#nearestVertex), and [nearestVertices()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-geometryEngine.html#nearestVertices) methods.
  *
  * @deprecated since version 4.32. Use {@link geometry/operators/support/proximityResult!ProximityResult proximityOperator's ProximityResult} instead.
+ * @since 5.0
  */
 export interface NearestPointResult<Point> {
-  /** A vertex within the specified distance of the search. */
+  /**
+   * A vertex within the specified distance of the search.
+   *
+   * @since 5.0
+   */
   coordinate: Point;
-  /** The distance from the `inputPoint` in the units of the view's spatial reference. */
+  /**
+   * The distance from the `inputPoint` in the units of the view's spatial reference.
+   *
+   * @since 5.0
+   */
   distance: number;
-  /** Indicates if it is an empty geometry. */
+  /**
+   * Indicates if it is an empty geometry.
+   *
+   * @since 5.0
+   */
   isEmpty: boolean;
-  /** The index of the vertex within the geometry's rings or paths. */
+  /**
+   * The index of the vertex within the geometry's rings or paths.
+   *
+   * @since 5.0
+   */
   vertexIndex: number;
 }

package/geometry/operators/types.d.ts

@@ -2,38 +2,63 @@ import type Extent from "../Extent.js";
 import type Point from "../Point.js";
 import type GeographicTransformation from "./support/GeographicTransformation.js";
 
-/** Object returned from the [getNearestCoordinate()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-operators-proximityOperator.html#getNearestCoordinate), {@link geometry/operators/proximityOperator#nearestVegetNearestVertex getNearestVertex()}, and [getNearestVertices()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-operators-proximityOperator.html#getNearestVertices) methods. */
+/**
+ * Object returned from the [getNearestCoordinate()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-operators-proximityOperator.html#getNearestCoordinate), {@link geometry/operators/proximityOperator#nearestVegetNearestVertex getNearestVertex()}, and [getNearestVertices()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-operators-proximityOperator.html#getNearestVertices) methods.
+ *
+ * @since 5.0
+ */
 export interface ProximityResult {
-  /** The nearest coordinate on the geometry to the given input point. */
+  /**
+   * The nearest coordinate on the geometry to the given input point.
+   *
+   * @since 5.0
+   */
   coordinate: Point;
   /**
    * The planar distance between the input point and the nearest coordinate on the geometry.
    * Unless the `unit` option is set, the default is the spatial reference unit of the input geometries.
+   *
+   * @since 5.0
    */
   distance: number;
-  /** Indicates if the result is empty. */
+  /**
+   * Indicates if the result is empty.
+   *
+   * @since 5.0
+   */
   isEmpty: boolean;
   /**
    * Indicates if the nearest coordinate is on the right side or left side of the input point.
    *
    * > [!WARNING]
    * > This property will only be present when `calculateLeftRightSide` is set to `true` when calling `getNearestCoordinate()`.
+   *
+   * @since 5.0
    */
   isRightSide?: boolean;
-  /** The index of the vertex on the geometry that is closest to the input point. */
+  /**
+   * The index of the vertex on the geometry that is closest to the input point.
+   *
+   * @since 5.0
+   */
   vertexIndex: number;
 }
 
+/** @since 5.0 */
 export interface ProjectOptions {
   /**
    * An extent used to help pick the correct transform.
    * This is not used if the `geographicTransformation` option is provided.
    * The extent's spatial reference should be the same as the `geometries` spatial reference.
+   *
+   * @since 5.0
    */
   readonly areaOfInterestExtent?: Extent | null;
   /**
    * The geographic transformation used to transform the geometries.
    * Specify this parameter to project a geometry when the default transformation is not appropriate for your requirements.
+   *
+   * @since 5.0
    */
   readonly geographicTransformation?: GeographicTransformation | null;
 }

package/geometry/support/MeshVertexAttributes.d.ts

@@ -1,8 +1,10 @@
 import type { ClonableMixin, ClonableMixinProperties } from "../../core/Clonable.js";
 import type { JSONSupport, JSONSupportMixinProperties } from "../../core/JSONSupport.js";
 
+/** @since 5.0 */
 export interface MeshVertexAttributesProperties extends JSONSupportMixinProperties, ClonableMixinProperties, Partial<Pick<MeshVertexAttributes, "color" | "normal" | "position" | "tangent" | "uv">> {}
 
+/** @since 5.0 */
 export default abstract class MeshVertexAttributes extends MeshVertexAttributesSuperclass {
   /**
    * A flat array of the vertex colors (4 elements per vertex ranging from 0 to 255).
@@ -11,11 +13,17 @@ export default abstract class MeshVertexAttributes extends MeshVertexAttributesS
    * @since 4.9
    */
   accessor color: MeshVertexColor | null | undefined;
-  /** A flat array of the vertex normals (3 elements per vertex ranging from -1 to 1). */
+  /**
+   * A flat array of the vertex normals (3 elements per vertex ranging from -1 to 1).
+   *
+   * @since 5.0
+   */
   accessor normal: MeshVertexNormal | null | undefined;
   /**
    * A flat array of vertex positions. Vertex positions have x, y and z coordinates and they should be in the spatial
    * reference system of the geometry.
+   *
+   * @since 5.0
    */
   accessor position: MeshVertexPosition;
   /**
@@ -23,19 +31,30 @@ export default abstract class MeshVertexAttributes extends MeshVertexAttributesS
    * (-1 or +1) indicating handedness of the tangent basis). An array of 4-component vectors specifying per-vertex tangents.
    * Tangents are used (and currently required) for normal mapping—see [MeshMaterial#normalTexture](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-support-MeshMaterial.html#normalTexture).
    * For more details on the expected encoding of these, see the [glTF 2.0 spec](https://github.com/KhronosGroup/glTF/tree/master/specification/2.0).
+   *
+   * @since 5.0
    */
   accessor tangent: MeshVertexTangent | null | undefined;
-  /** A flat array of vertex uv coordinates (2 elements per vertex). */
+  /**
+   * A flat array of vertex uv coordinates (2 elements per vertex).
+   *
+   * @since 5.0
+   */
   accessor uv: MeshVertexUV | null | undefined;
 }
 declare const MeshVertexAttributesSuperclass: typeof JSONSupport & typeof ClonableMixin
 
+/** @since 5.0 */
 export type MeshVertexPosition = Float64Array<ArrayBuffer>;
 
+/** @since 5.0 */
 export type MeshVertexUV = Float32Array<ArrayBuffer>;
 
+/** @since 5.0 */
 export type MeshVertexNormal = Float32Array<ArrayBuffer>;
 
+/** @since 5.0 */
 export type MeshVertexTangent = Float32Array<ArrayBuffer>;
 
+/** @since 5.0 */
 export type MeshVertexColor = Uint8Array<ArrayBuffer>;