@arcgis/core 5.2.0-next.131 → 5.2.0-next.134

package/geometry/operators/geodeticUtilsOperator.d.ts

@@ -14,6 +14,7 @@ import type Point from "../Point.js";
 import type { LengthUnit } from "../../core/units.js";
 import type { GeodeticCurveType } from "../types.js";
 
+/** @since 5.2 */
 export interface GeodeticUtilsOptions {
   /**
    * The type of geodetic curve along which distance will be measured.
@@ -40,6 +41,8 @@ export type Options = GeodeticUtilsOptions;
 /**
  * Object returned by the [calculateDistanceAndAzimuth()](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/geodeticUtilsOperator/#calculateDistanceAndAzimuth) method.
  * Azimuths are in positive degrees from 0 to 360, measured clockwise from due north.
+ *
+ * @since 5.2
  */
 export interface CalculateDistanceAndAzimuthResult {
   /** The geodetic distance between `point1` and `point2`. */
@@ -64,6 +67,7 @@ export interface CalculateDistanceAndAzimuthResult {
  * Indicates if all dependencies of this module have been loaded.
  *
  * @returns Returns `true` if this module's dependencies have been loaded.
+ * @since 5.2
  */
 export function geodeticUtilsIsLoaded(): boolean;
 
@@ -81,6 +85,7 @@ export function isLoaded(): boolean;
  * Loads this module's dependencies. This method must be called first if `geodeticUtilsIsLoaded` returns `false`.
  *
  * @returns Resolves when the dependencies have been loaded.
+ * @since 5.2
  * @see [geodeticUtilsIsLoaded()](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/geodeticUtilsOperator/#geodeticUtilsIsLoaded)
  */
 export function geodeticUtilsLoad(): Promise<void>;
@@ -106,6 +111,7 @@ export function load(): Promise<void>;
  * @param point2 - The ending point.
  * @param options - Additional options.
  * @returns Returns an object containing the distance and azimuths between the two points.
+ * @since 5.2
  * @example
  * if (!geodeticUtilsIsLoaded()) {
  *   await geodeticUtilsLoad();
@@ -156,6 +162,7 @@ export function calculateDistanceAndAzimuth(point1: Point, point2: Point, option
  * A negative azimuth is measured counter-clockwise from north.
  * @param options - Additional options.
  * @returns Returns the new point or `null` if the point cannot be represented in the spatial reference.
+ * @since 5.2
  * @example
  * if (!geodeticUtilsIsLoaded()) {
  *   await geodeticUtilsLoad();

package/geometry/operators/graphicBufferOperator.d.ts

@@ -9,6 +9,7 @@ import type Polygon from "../Polygon.js";
 import type { LengthUnit } from "../../core/units.js";
 import type { GeometryUnion } from "../types.js";
 
+/** @since 5.2 */
 export interface GraphicBufferOptions {
   /**
    * The max deviation of the result buffer from the true buffer in the spatial reference units of `geometries`.
@@ -70,6 +71,7 @@ export type Options = GraphicBufferOptions;
  * * Open polylines paths with round caps degenerate to a point and will be drawn as circles (degenerate with zero tolerance).
  * @param options - Additional options.
  * @returns Returns the buffered geometries.
+ * @since 5.2
  * @example
  * // Buffer two polylines with different distances and buffer styles.
  * const buffers = graphicBufferExecuteMany(
@@ -119,6 +121,8 @@ export function executeMany(geometries: GeometryUnion[], distances: number[], jo
 /**
  * Indicates if the operator supports input geometries that contain curves.
  * The value will always be `true`. This will produce densified output geometries.
+ *
+ * @since 5.2
  */
 export const graphicBufferSupportsCurves: boolean;
 

package/geometry/operators/integrateOperator.d.ts

@@ -16,6 +16,7 @@ import type { GeometryUnion, GeometryWithoutMeshUnion } from "../types.js";
  * All the geometries must have the same spatial reference.
  * @returns Returns the result of the subtraction.
  * The operation filters out degenerate segments and returns `null` for empty geometries.
+ * @since 5.2
  * @example
  * // Integrate a set of geometries
  * const result = integrateExecuteMany(geometries);
@@ -41,6 +42,8 @@ export function executeMany(geometries: GeometryUnion[]): (GeometryWithoutMeshUn
 /**
  * Indicates if the operator supports input geometries that contain curves.
  * The value will always be `true`.
+ *
+ * @since 5.2
  */
 export const integrateSupportsCurves: boolean;
 

package/geometry/operators/intersectionOperator.d.ts

@@ -12,6 +12,7 @@ import type { GeometryUnion, GeometryWithoutMeshUnion } from "../types.js";
  *
  * @param geometry - The geometry to accelerate.
  * @returns Returns `true` if the geometry was successfully accelerated.
+ * @since 5.2
  */
 export function intersectionAccelerateGeometry(geometry: GeometryUnion): boolean;
 
@@ -56,6 +57,7 @@ export function accelerateGeometry(geometry: GeometryUnion): boolean;
  * @param geometry1 - The geometry to intersect with  `geometry2`.
  * @param geometry2 - The geometry to intersect with `geometry1`.
  * @returns Returns the result of the intersection of the two geometries or null.
+ * @since 5.2
  * @example
  * // Creates a new geometry based on the intersection of two polygons
  * const intersection = intersectionExecute(polygon1, polygon2);
@@ -125,6 +127,7 @@ export function execute(geometry1: GeometryUnion, geometry2: GeometryUnion): Geo
  * @param intersector - The geometry to intersect with the `geometries`.
  * @returns Returns an array of geometries created by intersecting
  * every geometry in the input geometries with the `intersector`, or an empty array if there is no intersection.
+ * @since 5.2
  */
 export function intersectionExecuteMany(geometries: GeometryUnion[], intersector: GeometryUnion): GeometryWithoutMeshUnion[];
 
@@ -161,6 +164,8 @@ export function executeMany(geometries: GeometryUnion[], intersector: GeometryUn
 /**
  * Indicates if the operator supports input geometries that contain curves.
  * The value will always be `true`.
+ *
+ * @since 5.2
  */
 export const intersectionSupportsCurves: boolean;
 

package/geometry/operators/intersectsOperator.d.ts

@@ -14,6 +14,7 @@ import type { GeometryUnion } from "../types.js";
  *
  * @param geometry - The geometry to accelerate.
  * @returns Returns `true` if the geometry was successfully accelerated.
+ * @since 5.2
  */
 export function intersectsAccelerateGeometry(geometry: GeometryUnion): boolean;
 
@@ -34,6 +35,7 @@ export function accelerateGeometry(geometry: GeometryUnion): boolean;
  * @param geometry1 - The geometry that is tested for the intersects relationship to `geometry2`.
  * @param geometry2 - The geometry being intersected.
  * @returns Returns `true` if `geometry1` intersects with `geometry2`.
+ * @since 5.2
  * @example
  * // Returns true if two geometries intersect
  * const isIntersecting = intersectsExecute(polyline1, polyline2);
@@ -58,6 +60,8 @@ export function execute(geometry1: GeometryUnion, geometry2: GeometryUnion): boo
 /**
  * Indicates if the operator supports input geometries that contain curves.
  * The value will always be `true`.
+ *
+ * @since 5.2
  */
 export const intersectsSupportsCurves: boolean;
 

package/geometry/operators/isNearOperator.d.ts

@@ -8,6 +8,7 @@
 import type { LengthUnit } from "../../core/units.js";
 import type { GeometryUnion } from "../types.js";
 
+/** @since 5.2 */
 export interface IsNearOptions {
   /**
    * The length unit of the distance.
@@ -33,6 +34,7 @@ export type Options = IsNearOptions;
  * Unless the `unit` option is set, the default is the geometry's spatial reference unit.
  * @param options - Additional options.
  * @returns Returns `true` if the minimum distance between the two geometries is equal or less than `distance`.
+ * @since 5.2
  * @example
  * // Check if two geometries are near each other
  * const isNear = isNearExecute(point, polyline, 100);
@@ -60,6 +62,8 @@ export function execute(geometry1: GeometryUnion, geometry2: GeometryUnion, dist
 /**
  * Indicates if the operator supports input geometries that contain curves.
  * The value will always be `true`.
+ *
+ * @since 5.2
  */
 export const isNearSupportsCurves: boolean;
 

package/geometry/operators/labelPointOperator.d.ts

@@ -20,6 +20,7 @@ import type { GeometryUnion } from "../types.js";
  *
  * @param geometry - The input geometry.
  * @returns Returns the label point.
+ * @since 5.2
  * @example
  * // Perform the label point operation
  * const labelPoint = labelPointExecute(polygon);
@@ -46,6 +47,7 @@ export function execute(geometry: GeometryUnion): Point;
  * @param geometries - The set of input geometries.
  * All the geometries must have the same spatial reference.
  * @returns Returns the label points for each geometry.
+ * @since 5.2
  */
 export function labelPointExecuteMany(geometries: GeometryUnion[]): Point[];
 
@@ -64,6 +66,8 @@ export function executeMany(geometries: GeometryUnion[]): Point[];
 /**
  * Indicates if the operator supports input geometries that contain curves.
  * The value will always be `true`.
+ *
+ * @since 5.2
  */
 export const labelPointSupportsCurves: boolean;
 

package/geometry/operators/lengthOperator.d.ts

@@ -8,6 +8,7 @@
 import type { LengthUnit } from "../../core/units.js";
 import type { GeometryUnion } from "../types.js";
 
+/** @since 5.2 */
 export interface LengthOptions {
   /**
    * The length unit of the return value.
@@ -30,6 +31,7 @@ export type Options = LengthOptions;
  * @param geometry - The geometry to calculate the length from.
  * @param options - Additional options.
  * @returns Returns the planar length of the geometry.
+ * @since 5.2
  * @example
  * // Calculate the length of a polyline
  * const length = lengthExecute(polyline);
@@ -56,6 +58,7 @@ export function execute(geometry: GeometryUnion, options?: LengthOptions): numbe
  * The value will always be `true`.
  *
  * @default true
+ * @since 5.2
  */
 export const lengthSupportsCurves: boolean;
 

package/geometry/operators/linesToPolygonsOperator.d.ts

@@ -12,6 +12,7 @@ import type { GeometryUnion } from "../types.js";
  * @param geometries - The set of input geometries.
  * All the geometries must have the same spatial reference.
  * @returns Returns the result of polygons.
+ * @since 5.2
  * @example
  * // Perform the lines to polygons operation
  * const polygons = linesToPolygonsExecuteMany([polyline1, polyline2]);
@@ -36,6 +37,8 @@ export function executeMany(geometries: GeometryUnion[]): Polygon[];
 /**
  * Indicates if the operator supports input geometries that contain curves.
  * The value will always be `true`.
+ *
+ * @since 5.2
  */
 export const linesToPolygonsSupportsCurves: boolean;
 

package/geometry/operators/locateBetweenOperator.d.ts

@@ -21,6 +21,7 @@ import type { GeometryUnion, GeometryWithoutMeshUnion } from "../types.js";
  * @returns Returns the result of geometries.
  * For 1-dimensional geometries, the result could be either point, multipoint, or polyline.
  * For polylines, the result can be both polyline and multipoint.
+ * @since 5.2
  * @example
  * // Perform the locate between operation
  * const geometries = locateBetweenExecuteMany([polyline1, polyline2], 100, 200);
@@ -50,6 +51,8 @@ export function executeMany(geometries: GeometryUnion[], startM: number, endM: n
 /**
  * Indicates if the operator supports input geometries that contain curves.
  * The value will always be `true`.
+ *
+ * @since 5.2
  */
 export const locateBetweenSupportsCurves: boolean;
 

package/geometry/operators/minimumBoundingCircleOperator.d.ts

@@ -14,6 +14,7 @@
 import type Polygon from "../Polygon.js";
 import type { GeometryUnion } from "../types.js";
 
+/** @since 5.2 */
 export interface MinimumBoundingCircleOptions {
   /**
    * If `true`, the input geometries will be merged into a single geometry before
@@ -36,6 +37,7 @@ export type Options = MinimumBoundingCircleOptions;
  *
  * @param geometry - The input geometry.
  * @returns Returns the minimum bounding circle polygon with [curves](https://developers.arcgis.com/javascript/latest/references/core/geometry/Polygon/#curveRings).
+ * @since 5.2
  * @example
  * // Perform the minimum bounding circle operation
  * const minimumBoundingCircle = minimumBoundingCircleExecute(polygon);
@@ -63,6 +65,7 @@ export function execute(geometry: GeometryUnion): Polygon;
  * All the geometries must have the same spatial reference.
  * @param options - Additional options.
  * @returns Returns the minimum bounding circle polygons with [curves](https://developers.arcgis.com/javascript/latest/references/core/geometry/Polygon/#curveRings).
+ * @since 5.2
  */
 export function minimumBoundingCircleExecuteMany(geometries: GeometryUnion[], options?: MinimumBoundingCircleOptions): Polygon[];
 
@@ -82,6 +85,8 @@ export function executeMany(geometries: GeometryUnion[], options?: MinimumBoundi
 /**
  * Indicates if the operator supports input geometries that contain curves.
  * The value will always be `false`.
+ *
+ * @since 5.2
  */
 export const minimumBoundingCircleSupportsCurves: boolean;
 

package/geometry/operators/multiPartToSinglePartOperator.d.ts

@@ -7,6 +7,7 @@
  */
 import type { GeometryUnion, GeometryWithoutMeshUnion } from "../types.js";
 
+/** @since 5.2 */
 export interface MultiPartToSinglePartOptions {
   /**
    * When this parameter is set to false, the input polygons will not be simplified before converting them to single part geometries. Make sure the input polygons are topologically simple.
@@ -35,6 +36,7 @@ export type Options = MultiPartToSinglePartOptions;
  * @returns Returns the single part geometries.
  * For non-simple polygons, the output of the method is not guaranteed to be correct if the `simplifyPolgons` option is set to `false`.
  * In that case, the method may either throw an error, or produce some output which is not guaranteed to be correct.
+ * @since 5.2
  * @example
  * // Convert multipart geometries to single part geometries
  * const singlePartGeometries = multiPartToSinglePartExecuteMany(multiPartGeometries);
@@ -64,6 +66,8 @@ export function executeMany(geometries: GeometryUnion[], options?: MultiPartToSi
 /**
  * Indicates if the operator supports input geometries that contain curves.
  * The value will always be `true`.
+ *
+ * @since 5.2
  */
 export const multiPartToSinglePartSupportsCurves: boolean;
 

package/geometry/operators/offsetOperator.d.ts

@@ -45,6 +45,7 @@
 import type { LengthUnit } from "../../core/units.js";
 import type { GeometryUnion, GeometryWithoutMeshUnion } from "../types.js";
 
+/** @since 5.2 */
 export interface OffsetOptions {
   /**
    * The maximum distance of the resulting segments compared to the true circular arc (used only when joins is round).
@@ -99,6 +100,7 @@ export type Options = OffsetOptions;
  * @param options - Additional options.
  * @returns Returns the offset geometry or null.
  * Very acute angles can return null when an offset geometry segment cannot be created with the given parameters.
+ * @since 5.2
  * @example
  * // Create an offset polygon.
  * const offsetPolygon = offsetExecute(polygon, 100);
@@ -137,6 +139,7 @@ export function execute(geometry: GeometryUnion, distance: number, options?: Off
  * Unless the `unit` option is set, the default is the spatial reference unit of `geometries`.
  * @param options - Additional options.
  * @returns Returns the offset geometry results or null. Very acute angles can return null when an offset geometry segment cannot be created with the given parameters.
+ * @since 5.2
  */
 export function offsetExecuteMany(geometries: GeometryUnion[], distance: number, options?: OffsetOptions): (GeometryWithoutMeshUnion | null | undefined)[];
 
@@ -160,6 +163,8 @@ export function executeMany(geometries: GeometryUnion[], distance: number, optio
 /**
  * Indicates if the operator supports input geometries that contain curves.
  * The value will always be `true`. This will produce densified output geometries.
+ *
+ * @since 5.2
  */
 export const offsetSupportsCurves: boolean;
 

package/geometry/operators/overlapsOperator.d.ts

@@ -12,6 +12,7 @@ import type { GeometryUnion } from "../types.js";
  *
  * @param geometry - The geometry to accelerate.
  * @returns Returns `true` if the geometry was successfully accelerated.
+ * @since 5.2
  */
 export function overlapsAccelerateGeometry(geometry: GeometryUnion): boolean;
 
@@ -32,6 +33,7 @@ export function accelerateGeometry(geometry: GeometryUnion): boolean;
  * @param geometry1 - The base geometry that is tested for the "overlaps" relationship with `geometry2`.
  * @param geometry2 - The comparison geometry that is tested for the "overlaps" relationship with `geometry1`.
  * @returns Returns `true` if the intersection set results in a geometry different from both of the input geometries, but of the same dimension. For example, if `geometry1` and `geometry2` are both polygons, then they must return a polygon in order to overlap. If two polygons cross each other at exactly one point then no overlap has occurred because points have a dimension of 0 and polygons have a dimension of 2. See the [Working with spatial relationship operators](https://developers.arcgis.com/javascript/latest/spatial-analysis/intro-geometry-operators/#dimensionality) guide topic on dimensionality for more details.
+ * @since 5.2
  * @example
  * // Returns true if one geometry overlaps another,
  * // but is not contained or disjoint
@@ -58,6 +60,8 @@ export function execute(geometry1: GeometryUnion, geometry2: GeometryUnion): boo
 /**
  * Indicates if the operator supports input geometries that contain curves.
  * The value will always be `true`.
+ *
+ * @since 5.2
  */
 export const overlapsSupportsCurves: boolean;
 

package/geometry/operators/polygonOverlayOperator.d.ts

@@ -6,6 +6,7 @@
  */
 import type Polygon from "../Polygon.js";
 
+/** @since 5.2 */
 export interface PolygonOverlayOptions {
   /**
    * Output overlapping areas of polygons.
@@ -46,7 +47,11 @@ export interface PolygonOverlayOptions {
  */
 export type Options = PolygonOverlayOptions;
 
-/** Object returned by the [polygonOverlayExecuteMany()](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/polygonOverlayOperator/#polygonOverlayExecuteMany) method. */
+/**
+ * Object returned by the [polygonOverlayExecuteMany()](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/polygonOverlayOperator/#polygonOverlayExecuteMany) method.
+ *
+ * @since 5.2
+ */
 export interface ExecuteManyResult {
   /** The array of polygons returned by the operator. */
   results: Polygon[];
@@ -62,6 +67,7 @@ export interface ExecuteManyResult {
  * @param options - Additional options.
  * @returns Returns the result polygons and ids.
  * Overlaps have two or more ids, no-overlaps have one id, and gaps have no ids.
+ * @since 5.2
  * @example
  * // Overlay a set of polygons
  * const result = polygonOverlayExecuteMany(polygons);
@@ -88,6 +94,8 @@ export function executeMany(polygons: Polygon[], options?: PolygonOverlayOptions
 /**
  * Indicates if the operator supports input polygons that contain curves.
  * The value will always be `true`.
+ *
+ * @since 5.2
  */
 export const polygonOverlaySupportsCurves: boolean;
 

package/geometry/operators/polygonSlicerOperator.d.ts

@@ -7,6 +7,7 @@ import type Polygon from "../Polygon.js";
 import type Transformation from "./support/Transformation.js";
 import type { AreaUnit } from "../../core/units.js";
 
+/** @since 5.2 */
 export interface PolygonSlicerOptions {
   /**
    * The affine transformation to apply to the polygon before slicing. When applying the transformation, the slicing starts from the bottom and proceeds to the top. The default is the identity transformation.
@@ -22,6 +23,7 @@ export interface PolygonSlicerOptions {
  */
 export type Options = PolygonSlicerOptions;
 
+/** @since 5.2 */
 export interface PolygonSlicerFindSlicesByAreaOptions extends PolygonSlicerOptions {
   /**
    * The area unit of the remaining area.
@@ -48,6 +50,7 @@ export type FindSlicesByAreaOptions = PolygonSlicerFindSlicesByAreaOptions;
  * @param options - Additional options.
  * @returns Returns the y-coordinate set for the slice positions sorted in increasing y-order. The set can be used as input to the
  * [polygonSlicerSliceIntoStrips()](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/polygonSlicerOperator/#polygonSlicerSliceIntoStrips) method.
+ * @since 5.2
  * @example
  * // Find the slice positions for a polygon
  * const slicePositions = polygonSlicerFindSlicesByArea(polygon, 3, 0);
@@ -81,6 +84,7 @@ export function findSlicesByArea(polygon: Polygon, partCount: number, remainingA
  * @param options - Additional options.
  * @returns Returns the array of polygons that are the result of the slicing.
  * The number of output polygons will not necessarily match the number of requested slices. For example, if some of the slices became degenerate, they may not be output. The method uses topological operations that rely on the tolerance value in the input spatial reference. These operations may shift vertices in a way that affects result areas.
+ * @since 5.2
  * @example
  * // Slice a polygon into equal area parts
  * const slicedPolygons = polygonSlicerRecursiveSliceEqualArea(polygon, 3);
@@ -112,6 +116,7 @@ export function recursiveSliceEqualArea(polygon: Polygon, partCount: number, opt
  * @param options - Additional options.
  * @returns Returns the array of polygons that are the result of the slicing.
  * The number of output polygons will not necessarily match the number of requested slices. For example, if some of the slices became degenerate, they may not be output. The method uses topological operations that rely on the tolerance value in the input spatial reference. These operations may shift vertices in a way that affects result areas.
+ * @since 5.2
  * @example
  * // Slice a polygon into strips
  * const slicedPolygons = polygonSlicerSliceIntoStrips(polygon, [100, 200, 300]);
@@ -138,6 +143,8 @@ export function sliceIntoStrips(polygon: Polygon, ySlices: number[], options?: P
 /**
  * Indicates if the operator supports input geometries that contain curves.
  * The value will always be `true`.
+ *
+ * @since 5.2
  */
 export const polygonSlicerSupportsCurves: boolean;
 

package/geometry/operators/projectOperator.d.ts

@@ -48,6 +48,7 @@ import type { ProjectOptions } from "./types.js";
  * Indicates if all dependencies of this module have been loaded.
  *
  * @returns Returns `true` if this module's dependencies have been loaded.
+ * @since 5.2
  */
 export function projectIsLoaded(): boolean;
 
@@ -65,6 +66,7 @@ export function isLoaded(): boolean;
  * Loads this module's dependencies. This method must be called first if `projectIsLoaded` returns `false`.
  *
  * @returns Resolves when the dependencies have been loaded.
+ * @since 5.2
  * @see [projectIsLoaded()](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/projectOperator/#projectIsLoaded)
  */
 export function projectLoad(): Promise<void>;
@@ -87,6 +89,7 @@ export function load(): Promise<void>;
  * @param outSpatialReference - The spatial reference to which the input geometry is projected.
  * @param options - Additional options.
  * @returns Returns the projected geometry or null.
+ * @since 5.2
  * @example
  * if (!projectIsLoaded()) {
  *   await projectLoad();
@@ -133,6 +136,7 @@ export function execute(geometry: GeometryUnion, outSpatialReference: SpatialRef
  * @param outSpatialReference - The spatial reference to which the input geometry is projected.
  * @param options - Additional options.
  * @returns Returns the projected geometries or null.
+ * @since 5.2
  */
 export function projectExecuteMany(geometries: GeometryUnion[], outSpatialReference: SpatialReference, options?: ProjectOptions): (GeometryWithoutMeshUnion | null | undefined)[];
 
@@ -154,6 +158,8 @@ export function executeMany(geometries: GeometryUnion[], outSpatialReference: Sp
  * Indicates if the operator supports input geometries that contain curves.
  * The value is `null` or `undefined` until the operator is loaded, then it will always be `true`.
  * This will produce densified output geometries.
+ *
+ * @since 5.2
  */
 export const projectSupportsCurves: boolean | null | undefined;
 

package/geometry/operators/proximityOperator.d.ts

@@ -11,6 +11,7 @@ import type { LengthUnit } from "../../core/units.js";
 import type { GeometryUnion } from "../types.js";
 import type { ProximityResult } from "./types.js";
 
+/** @since 5.2 */
 export interface ProximityOptions {
   /**
    * The length unit of the search radius and result distances.
@@ -27,6 +28,7 @@ export interface ProximityOptions {
  */
 export type Options = ProximityOptions;
 
+/** @since 5.2 */
 export interface ProximityGetNearestCoordinateOptions extends ProximityOptions {
   /**
    * When the parameter is set to true, this function will calculate the left/right side of a polyline or polygon.
@@ -59,6 +61,7 @@ export type GetNearestCoordinateOptions = ProximityGetNearestCoordinateOptions;
  * @param point - The point used to search for the nearest coordinate in `geometry`.
  * @param options - Additional options.
  * @returns Returns the proximity result which contains the nearest coordinate on the input `geometry` to the given `inputPoint`.
+ * @since 5.2
  * @example
  * // Return the nearest result on a polygon to the given point
  * const proximityResult = proximityGetNearestCoordinate(polygon, point);
@@ -88,6 +91,7 @@ export function getNearestCoordinate(geometry: GeometryUnion, point: Point, opti
  * @param point - The point used to search for the nearest coordinate in the input `geometry`.
  * @param options - Additional options.
  * @returns Returns the proximity result which contains the nearest vertex on the `geometry` to the given `inputPoint`.
+ * @since 5.2
  * @example
  * // Return the nearest vertex on a polygon to the given point
  * const proximityResult = proximityGetNearestCoordinate(polygon, point);
@@ -123,6 +127,7 @@ export function getNearestVertex(geometry: GeometryUnion, point: Point, options?
  * The array is sorted by distance to the `inputPoint` with the closest point first.
  * When there are more than the `maxVertexCountToReturn` vertices to return, it returns the closest vertices.
  * The array will be empty when `geometry` is empty.
+ * @since 5.2
  * @example
  * // Return the nearest vertices on a polygon to the given point
  * const proximityResultsArray = proximityGetNearestVertices(polygon, point, 100, 5);
@@ -154,6 +159,8 @@ export function getNearestVertices(geometry: GeometryUnion, point: Point, search
 /**
  * Indicates if the operator supports input geometries that contain curves.
  * The value will always be `true`.
+ *
+ * @since 5.2
  */
 export const proximitySupportsCurves: boolean;
 

package/geometry/operators/relateOperator.d.ts

@@ -12,6 +12,7 @@ import type { GeometryUnion } from "../types.js";
  *
  * @param geometry - The geometry to accelerate.
  * @returns Returns `true` if the geometry was successfully accelerated.
+ * @since 5.2
  */
 export function relateAccelerateGeometry(geometry: GeometryUnion): boolean;
 
@@ -31,6 +32,7 @@ export function accelerateGeometry(geometry: GeometryUnion): boolean;
  * @param geometry2 - The second geometry for the relation.
  * @param relation - The DE-9IM matrix relation encoded as a string to test against the relationship of the two geometries
  * @returns Returns `true` if the two geometries satisfy the DE-9IM matrix relation.
+ * @since 5.2
  * @example
  * // Returns true if the polygon geometry completely
  * // contains the polyline based on the DE-9IM string
@@ -58,6 +60,7 @@ export function execute(geometry1: GeometryUnion, geometry2: GeometryUnion, rela
  *
  * @param relation - The DE-9IM matrix relation encoded as a string.
  * @returns Returns `true` if the DE-9IM matrix relation is valid.
+ * @since 5.2
  */
 export function relateIsValidDE9IM(relation: string): boolean;
 
@@ -75,6 +78,8 @@ export function isValidDE9IM(relation: string): boolean;
 /**
  * Indicates if the operator supports input geometries that contain curves.
  * The value will always be `true`.
+ *
+ * @since 5.2
  */
 export const relateSupportsCurves: boolean;
 

package/geometry/operators/reshapeOperator.d.ts

@@ -17,6 +17,7 @@ import type Polyline from "../Polyline.js";
  * @param reshaper - The single path polyline reshaper.
  * @returns If the `geometry` is a polygon, the return type is polygon, and if the `geometry` is a polyline, the return type is polyline.
  * If the `geometry` cannot be reshaped, then the return type is null.
+ * @since 5.2
  * @example
  * // Reshape a polygon geometry
  * const reshapedPolygon = reshapeExecute(polygon, reshaperPolyline);
@@ -46,6 +47,8 @@ export function execute(geometry: Polygon | Polyline, reshaper: Polyline): Polyg
 /**
  * Indicates if the operator supports input geometries that contain curves.
  * The value will always be `false`.
+ *
+ * @since 5.2
  */
 export const reshapeSupportsCurves: boolean;
 

package/geometry/operators/shapePreservingProjectOperator.d.ts

@@ -42,6 +42,7 @@ import type SpatialReference from "../SpatialReference.js";
 import type GeographicTransformation from "./support/GeographicTransformation.js";
 import type { GeometryUnion, GeometryWithoutMeshUnion } from "../types.js";
 
+/** @since 5.2 */
 export interface ShapePreservingProjectOptions {
   /**
    * An extent used to help pick the correct transform.
@@ -81,6 +82,7 @@ export type Options = ShapePreservingProjectOptions;
  * Indicates if all dependencies of this module have been loaded.
  *
  * @returns Returns `true` if this module's dependencies have been loaded.
+ * @since 5.2
  */
 export function shapePreservingProjectIsLoaded(): boolean;
 
@@ -98,6 +100,7 @@ export function isLoaded(): boolean;
  * Loads this module's dependencies. This method must be called first if `shapePreservingProjectIsLoaded` returns `false`.
  *
  * @returns Resolves when the dependencies have been loaded.
+ * @since 5.2
  * @see [shapePreservingProjectIsLoaded()](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/shapePreservingProjectOperator/#shapePreservingProjectIsLoaded)
  */
 export function shapePreservingProjectLoad(): Promise<void>;
@@ -120,6 +123,7 @@ export function load(): Promise<void>;
  * @param outSpatialReference - The spatial reference to which the input geometry is projected.
  * @param options - Additional options.
  * @returns The projected geometry or null.
+ * @since 5.2
  * @example
  * if (!shapePreservingProjectIsLoaded()) {
  *   await shapePreservingProjectLoad();
@@ -158,6 +162,7 @@ export function execute(geometry: GeometryUnion, outSpatialReference: SpatialRef
  * @param outSpatialReference - The spatial reference to which the input geometries are projected.
  * @param options - Additional options.
  * @returns Returns the projected geometries or null.
+ * @since 5.2
  */
 export function shapePreservingProjectExecuteMany(geometries: GeometryUnion[], outSpatialReference: SpatialReference, options?: ShapePreservingProjectOptions): (GeometryWithoutMeshUnion | null | undefined)[];
 
@@ -178,6 +183,8 @@ export function executeMany(geometries: GeometryUnion[], outSpatialReference: Sp
 /**
  * Indicates if the operator supports input geometries that contain curves.
  * The value is `null` or `undefined` until the operator is loaded, then it will always be `false`.
+ *
+ * @since 5.2
  */
 export const shapePreservingProjectSupportsCurves: boolean | null | undefined;