@arcgis/core 5.2.0-next.95 → 5.2.0-next.96

package/geometry/operators/boundaryOperator.d.ts

@@ -16,7 +16,23 @@ import type { GeometryUnion, GeometryWithoutMeshUnion } from "../types.js";
  * - Polygon returns a polyline describing its outer and inner rings.
  * @example
  * // Calculate the boundary of a polygon
- * const boundaryGeometry = boundaryOperator.execute(polygon);
+ * const boundaryGeometry = boundaryExecute(polygon);
+ */
+export function boundaryExecute(geometry: GeometryUnion): GeometryWithoutMeshUnion | null | undefined;
+
+/**
+ * Calculates the boundary on the input geometry.
+ *
+ * @deprecated since 5.2 use [boundaryExecute()](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/boundaryOperator/#boundaryExecute)
+ * @param geometry - The input geometry.
+ * @returns Returns the boundary geometry or null.
+ * - Using point or multipoint as the input geometry returns null.
+ * - Extent returns a polyline that bounds the extent.
+ * - Polyline returns a multipoint containing the end points of the polyline's parts.
+ * - Polygon returns a polyline describing its outer and inner rings.
+ * @example
+ * // Calculate the boundary of a polygon
+ * const boundaryGeometry = boundaryExecute(polygon);
  */
 export function execute(geometry: GeometryUnion): GeometryWithoutMeshUnion | null | undefined;
 
@@ -31,10 +47,32 @@ export function execute(geometry: GeometryUnion): GeometryWithoutMeshUnion | nul
  * - Polyline returns a multipoint containing the end points of the polyline's parts.
  * - Polygon returns a polyline describing its outer and inner rings.
  */
+export function boundaryExecuteMany(geometries: GeometryUnion[]): (GeometryWithoutMeshUnion | null | undefined)[];
+
+/**
+ * Calculates the boundaries on a set of geometries.
+ *
+ * @deprecated since 5.2 use [boundaryExecuteMany()](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/boundaryOperator/#boundaryExecuteMany)
+ * @param geometries - The input geometries.
+ * All the geometries must have the same spatial reference.
+ * @returns Returns the boundary geometries or null.
+ * - Using point or multipoint as the input geometry returns null.
+ * - Extent returns a polyline that bounds the extent.
+ * - Polyline returns a multipoint containing the end points of the polyline's parts.
+ * - Polygon returns a polyline describing its outer and inner rings.
+ */
 export function executeMany(geometries: GeometryUnion[]): (GeometryWithoutMeshUnion | null | undefined)[];
 
 /**
  * Indicates if the operator supports input geometries that contain curves.
  * The value will always be `true`.
  */
-export const supportsCurves: boolean;
+export const boundarySupportsCurves: boolean;
+
+/**
+ * Indicates if the operator supports input geometries that contain curves.
+ * The value will always be `true`.
+ *
+ * @deprecated since 5.2 use [boundarySupportsCurves](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/boundaryOperator/#boundarySupportsCurves)
+ */
+export const supportsCurves: ReturnType<typeof Boolean>;

package/geometry/operators/boundaryOperator.js

@@ -1,2 +1,2 @@
 /* COPYRIGHT Esri - https://js.arcgis.com/5.2/LICENSE.txt */
-import{supportsCurves as r,execute as o,executeMany as t}from"./gx/operatorBoundary.js";import{getSpatialReference as e,toGeometry as n,fromGeometry as s}from"./support/apiConverter.js";function p(r){const t=e(r);return n(o(s(r)),t)}function u(r){const o=r.map(s),p=e(r);return t(o).map(r=>n(r,p))}const a=r();export{p as execute,u as executeMany,a as supportsCurves};
+import{deprecatedFunction as e}from"../../core/deprecate.js";import r from"../../core/Logger.js";import{supportsCurves as o,execute as t,executeMany as n}from"./gx/operatorBoundary.js";import{getSpatialReference as a,toGeometry as u,fromGeometry as c}from"./support/apiConverter.js";function s(e){const r=a(e);return u(t(c(e)),r)}function p(o){return e(r.getLogger("esri.geometry.operators.boundaryOperator"),"execute is deprecated. Use boundaryExecute instead.",{replacement:"boundaryExecute",warnOnce:!0}),s(o)}function i(e){const r=e.map(c),o=a(e);return n(r).map(e=>u(e,o))}function d(o){return e(r.getLogger("esri.geometry.operators.boundaryOperator"),"executeMany is deprecated. Use boundaryExecuteMany instead.",{replacement:"boundaryExecuteMany",warnOnce:!0}),i(o)}const m=o(),y=Boolean(m);export{s as boundaryExecute,i as boundaryExecuteMany,m as boundarySupportsCurves,p as execute,d as executeMany,y as supportsCurves};

package/geometry/operators/bufferOperator.d.ts

@@ -13,7 +13,7 @@ import type Polygon from "../Polygon.js";
 import type { LengthUnit } from "../../core/units.js";
 import type { GeometryUnion } from "../types.js";
 
-export interface ExecuteOptions {
+export interface BufferExecuteOptions {
   /**
    * The length unit of the buffer distances and max deviation.
    *  The default is the input geometry's spatial reference unit.
@@ -22,7 +22,10 @@ export interface ExecuteOptions {
   unit?: LengthUnit;
 }
 
-export interface ExecuteManyOptions extends ExecuteOptions {
+/** @deprecated since 5.2 use [BufferExecuteOptions](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/bufferOperator/#BufferExecuteOptions) */
+export type ExecuteOptions = BufferExecuteOptions;
+
+export interface BufferExecuteManyOptions extends BufferExecuteOptions {
   /**
    * The max deviation of the result buffer from the true buffer.
    * When the value is NaN, internal logic is used to select deviation based on the buffer distance.
@@ -45,6 +48,9 @@ export interface ExecuteManyOptions extends ExecuteOptions {
   union?: boolean;
 }
 
+/** @deprecated since 5.2 use [BufferExecuteManyOptions](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/bufferOperator/#BufferExecuteManyOptions) */
+export type ExecuteManyOptions = BufferExecuteManyOptions;
+
 /**
  * Creates a buffer around the input geometry.
  *
@@ -54,9 +60,39 @@ export interface ExecuteManyOptions extends ExecuteOptions {
  * @returns Returns the buffered geometry or null.
  * @example
  * // Buffer a polyline geometry
- * const bufferGeometry = bufferOperator.execute(polyline, 1000);
+ * const bufferGeometry = bufferExecute(polyline, 1000);
+ */
+export function bufferExecute(geometry: GeometryUnion, distance: number, options?: BufferExecuteOptions): Polygon | null | undefined;
+
+/**
+ * Creates a buffer around the input geometry.
+ *
+ * @deprecated since 5.2 use [bufferExecute()](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/bufferOperator/#bufferExecute)
+ * @param geometry - The input geometry to be buffered.
+ * @param distance - The buffer distance for the geometry. Unless the `unit` option is set, the default is the geometry's spatial reference unit.
+ * @param options - Additional options.
+ * @returns Returns the buffered geometry or null.
+ * @example
+ * // Buffer a polyline geometry
+ * const bufferGeometry = bufferExecute(polyline, 1000);
+ */
+export function execute(geometry: GeometryUnion, distance: number, options?: BufferExecuteOptions): Polygon | null | undefined;
+
+/**
+ * Creates a buffer around the input geometries.
+ *
+ * Both `maxDeviation` and `maxVerticesInFullCircle` control the quality of round joins that are in the buffers.
+ * The precision of each buffer is `maxDeviation` unless the number of required vertices is too large.
+ *
+ * @param geometries - The input geometries to be buffered.
+ * All the geometries must have the same spatial reference.
+ * @param distances - The buffer distances for the geometries.
+ * If the size of this array is less than the number of geometries in the input `geometries`, the last distance value is used for the rest of geometries.
+ * Unless the `unit` option is set, the default is the geometries spatial reference unit.
+ * @param options - Additional options.
+ * @returns Returns the buffered geometries.
  */
-export function execute(geometry: GeometryUnion, distance: number, options?: ExecuteOptions): Polygon | null | undefined;
+export function bufferExecuteMany(geometries: GeometryUnion[], distances: number[], options?: BufferExecuteManyOptions): Polygon[];
 
 /**
  * Creates a buffer around the input geometries.
@@ -64,6 +100,7 @@ export function execute(geometry: GeometryUnion, distance: number, options?: Exe
  * Both `maxDeviation` and `maxVerticesInFullCircle` control the quality of round joins that are in the buffers.
  * The precision of each buffer is `maxDeviation` unless the number of required vertices is too large.
  *
+ * @deprecated since 5.2 use [bufferExecuteMany()](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/bufferOperator/#bufferExecuteMany)
  * @param geometries - The input geometries to be buffered.
  * All the geometries must have the same spatial reference.
  * @param distances - The buffer distances for the geometries.
@@ -72,10 +109,18 @@ export function execute(geometry: GeometryUnion, distance: number, options?: Exe
  * @param options - Additional options.
  * @returns Returns the buffered geometries.
  */
-export function executeMany(geometries: GeometryUnion[], distances: number[], options?: ExecuteManyOptions): Polygon[];
+export function executeMany(geometries: GeometryUnion[], distances: number[], options?: BufferExecuteManyOptions): Polygon[];
+
+/**
+ * Indicates if the operator supports input geometries that contain curves.
+ * The value will always be `true`. This will produce densified output geometries.
+ */
+export const bufferSupportsCurves: boolean;
 
 /**
  * Indicates if the operator supports input geometries that contain curves.
  * The value will always be `true`. This will produce densified output geometries.
+ *
+ * @deprecated since 5.2 use [bufferSupportsCurves](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/bufferOperator/#bufferSupportsCurves)
  */
-export const supportsCurves: boolean;
+export const supportsCurves: ReturnType<typeof Boolean>;

package/geometry/operators/bufferOperator.js

@@ -1,2 +1,2 @@
 /* COPYRIGHT Esri - https://js.arcgis.com/5.2/LICENSE.txt */
-import{isSome as r}from"../../core/arrayUtils.js";import{convertToSpatialReferenceUnit as t}from"../../core/units.js";import{supportsCurves as o,execute as e,executeManyEx as n}from"./gx/operatorBuffer.js";import{getSpatialReference as i,toPolygon as s,fromSpatialReference as p,fromGeometry as u}from"./support/apiConverter.js";function a(r,o,n={}){const{unit:a}=n,m=i(r);return a&&(o=t(o,a,m)),s(e(u(r),p(m),o),m)}function m(o,e,a={}){let{maxDeviation:m=NaN,maxVerticesInFullCircle:c=96,union:f=!1,unit:l}=a;const x=i(o);l&&(e=e.map(r=>t(r,l,x)),m&&(m=t(m,l,x)));const j=o.map(u);return n(j,p(x),e,m,c,f).map(r=>s(r,x)).filter(r)}const c=o();export{a as execute,m as executeMany,c as supportsCurves};
+import{isSome as e}from"../../core/arrayUtils.js";import{deprecatedFunction as r}from"../../core/deprecate.js";import t from"../../core/Logger.js";import{convertToSpatialReferenceUnit as o}from"../../core/units.js";import{supportsCurves as n,execute as a,executeManyEx as u}from"./gx/operatorBuffer.js";import{getSpatialReference as s,toPolygon as c,fromSpatialReference as i,fromGeometry as f}from"./support/apiConverter.js";function p(e,r,t={}){const{unit:n}=t,u=s(e);return n&&(r=o(r,n,u)),c(a(f(e),i(u),r),u)}function m(e,o,n={}){return r(t.getLogger("esri.geometry.operators.bufferOperator"),"execute is deprecated. Use bufferExecute instead.",{replacement:"bufferExecute",warnOnce:!0}),p(e,o,n)}function g(r,t,n={}){let{maxDeviation:a=NaN,maxVerticesInFullCircle:p=96,union:m=!1,unit:g}=n;const x=s(r);g&&(t=t.map(e=>o(e,g,x)),a&&(a=o(a,g,x)));const l=r.map(f);return u(l,i(x),t,a,p,m).map(e=>c(e,x)).filter(e)}function x(e,o,n={}){return r(t.getLogger("esri.geometry.operators.bufferOperator"),"executeMany is deprecated. Use bufferExecuteMany instead.",{replacement:"bufferExecuteMany",warnOnce:!0}),g(e,o,n)}const l=n(),d=Boolean(l);export{p as bufferExecute,g as bufferExecuteMany,l as bufferSupportsCurves,m as execute,x as executeMany,d as supportsCurves};

package/geometry/operators/centroidOperator.d.ts

@@ -22,7 +22,20 @@ import type { GeometryUnion } from "../types.js";
  * @returns The centroid of the geometry.
  * @example
  * // Return the centroid of a polygon
- * const centroid = centroidOperator.execute(polygon);
+ * const centroid = centroidExecute(polygon);
+ * console.log(`x: ${centroid.x}, y: ${centroid.y}`);
+ */
+export function centroidExecute(geometry: GeometryUnion): Point;
+
+/**
+ * Performs the centroid operation on a geometry.
+ *
+ * @deprecated since 5.2 use [centroidExecute()](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/centroidOperator/#centroidExecute)
+ * @param geometry - The geometry in which to calculate the centroid.
+ * @returns The centroid of the geometry.
+ * @example
+ * // Return the centroid of a polygon
+ * const centroid = centroidExecute(polygon);
  * console.log(`x: ${centroid.x}, y: ${centroid.y}`);
  */
 export function execute(geometry: GeometryUnion): Point;
@@ -31,4 +44,12 @@ export function execute(geometry: GeometryUnion): Point;
  * Indicates if the operator supports input geometries that contain curves.
  * The value will always be `true`.
  */
-export const supportsCurves: boolean;
+export const centroidSupportsCurves: boolean;
+
+/**
+ * Indicates if the operator supports input geometries that contain curves.
+ * The value will always be `true`.
+ *
+ * @deprecated since 5.2 use [centroidSupportsCurves](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/centroidOperator/#centroidSupportsCurves)
+ */
+export const supportsCurves: ReturnType<typeof Boolean>;

package/geometry/operators/centroidOperator.js

@@ -1,2 +1,2 @@
 /* COPYRIGHT Esri - https://js.arcgis.com/5.2/LICENSE.txt */
-import{OperatorCentroid2D as r}from"../../chunks/OperatorCentroid2D.js";import{fromGeometry as o,toPoint as t,getSpatialReference as e}from"./support/apiConverter.js";const n=new r;function s(r){const s=n.execute(o(r),null);return t(s,e(r))}const p=n.supportsCurves();export{s as execute,p as supportsCurves};
+import{OperatorCentroid2D as e}from"../../chunks/OperatorCentroid2D.js";import{deprecatedFunction as r}from"../../core/deprecate.js";import o from"../../core/Logger.js";import{fromGeometry as t,toPoint as n,getSpatialReference as c}from"./support/apiConverter.js";const s=new e;function p(e){const r=s.execute(t(e),null);return n(r,c(e))}function i(e){return r(o.getLogger("esri.geometry.operators.centroidOperator"),"execute is deprecated. Use centroidExecute instead.",{replacement:"centroidExecute",warnOnce:!0}),p(e)}const u=s.supportsCurves(),a=Boolean(u);export{p as centroidExecute,u as centroidSupportsCurves,i as execute,a as supportsCurves};

package/geometry/operators/clipOperator.d.ts

@@ -16,7 +16,20 @@ import type { GeometryUnion, GeometryWithoutMeshUnion } from "../types.js";
  * @returns Returns the clipped geometry or null.
  * @example
  * // return a new geometry of a polygon clipped by the view's extent
- * const clippedGeometry = clipOperator.execute(polygon, view.extent);
+ * const clippedGeometry = clipExecute(polygon, view.extent);
+ */
+export function clipExecute(geometry: GeometryUnion, extent: Extent): GeometryWithoutMeshUnion | null | undefined;
+
+/**
+ * Perform the clip operation on the input geometry.
+ *
+ * @deprecated since 5.2 use [clipExecute()](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/clipOperator/#clipExecute)
+ * @param geometry - The geometry to be clipped.
+ * @param extent - The extent used to clip the geometry.
+ * @returns Returns the clipped geometry or null.
+ * @example
+ * // return a new geometry of a polygon clipped by the view's extent
+ * const clippedGeometry = clipExecute(polygon, view.extent);
  */
 export function execute(geometry: GeometryUnion, extent: Extent): GeometryWithoutMeshUnion | null | undefined;
 
@@ -28,10 +41,29 @@ export function execute(geometry: GeometryUnion, extent: Extent): GeometryWithou
  * @param extent - The extent used to clip the geometries.
  * @returns Returns an array whose elements may either be clipped geometries or null.
  */
+export function clipExecuteMany(geometries: GeometryUnion[], extent: Extent): (GeometryWithoutMeshUnion | null | undefined)[];
+
+/**
+ * Perform the clip operation on the input geometries.
+ *
+ * @deprecated since 5.2 use [clipExecuteMany()](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/clipOperator/#clipExecuteMany)
+ * @param geometries - The array of geometries to be clipped.
+ * All the geometries must have the same spatial reference.
+ * @param extent - The extent used to clip the geometries.
+ * @returns Returns an array whose elements may either be clipped geometries or null.
+ */
 export function executeMany(geometries: GeometryUnion[], extent: Extent): (GeometryWithoutMeshUnion | null | undefined)[];
 
 /**
  * Indicates if the operator supports input geometries that contain curves.
  * The value will always be `true`.
  */
-export const supportsCurves: boolean;
+export const clipSupportsCurves: boolean;
+
+/**
+ * Indicates if the operator supports input geometries that contain curves.
+ * The value will always be `true`.
+ *
+ * @deprecated since 5.2 use [clipSupportsCurves](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/clipOperator/#clipSupportsCurves)
+ */
+export const supportsCurves: ReturnType<typeof Boolean>;

package/geometry/operators/clipOperator.js

@@ -1,2 +1,2 @@
 /* COPYRIGHT Esri - https://js.arcgis.com/5.2/LICENSE.txt */
-import{supportsCurves as e,execute as o,executeMany as r}from"./gx/operatorClip.js";import{getSpatialReference as t,fromExtent as p,toGeometry as s,fromSpatialReference as n,fromGeometry as a}from"./support/apiConverter.js";function u(e,r){const u=t(e),c=p(r).asEnvelope2D();return s(o(a(e),c,n(u)),u)}function c(e,o){const u=e.map(a),c=t(e),i=p(o).asEnvelope2D();return r(u,i,n(c)).map(e=>s(e,c))}const i=e();export{u as execute,c as executeMany,i as supportsCurves};
+import{deprecatedFunction as e}from"../../core/deprecate.js";import r from"../../core/Logger.js";import{supportsCurves as t,execute as o,executeMany as n}from"./gx/operatorClip.js";import{getSpatialReference as p,fromExtent as c,toGeometry as a,fromSpatialReference as s,fromGeometry as i}from"./support/apiConverter.js";function u(e,r){const t=p(e),n=c(r).asEnvelope2D();return a(o(i(e),n,s(t)),t)}function m(t,o){return e(r.getLogger("esri.geometry.operators.clipOperator"),"execute is deprecated. Use clipExecute instead.",{replacement:"clipExecute",warnOnce:!0}),u(t,o)}function l(e,r){const t=e.map(i),o=p(e),u=c(r).asEnvelope2D();return n(t,u,s(o)).map(e=>a(e,o))}function g(t,o){return e(r.getLogger("esri.geometry.operators.clipOperator"),"executeMany is deprecated. Use clipExecuteMany instead.",{replacement:"clipExecuteMany",warnOnce:!0}),l(t,o)}const x=t(),f=Boolean(x);export{u as clipExecute,l as clipExecuteMany,x as clipSupportsCurves,m as execute,g as executeMany,f as supportsCurves};

package/geometry/operators/containsOperator.d.ts

@@ -15,6 +15,15 @@ import type { GeometryUnion } from "../types.js";
  * @param geometry - The geometry to accelerate.
  * @returns Returns `true` if the geometry was successfully accelerated.
  */
+export function containsAccelerateGeometry(geometry: GeometryUnion): boolean;
+
+/**
+ * Accelerate a geometry. This method prepares the geometry for faster contains operations when the same geometry is tested multiple times (e.g. in a loop with hundreds of iterations). See the [Acceleration](https://developers.arcgis.com/javascript/latest/spatial-analysis/intro-geometry-operators/#acceleration) guide topic for more information.
+ *
+ * @deprecated since 5.2 use [containsAccelerateGeometry()](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/containsOperator/#containsAccelerateGeometry)
+ * @param geometry - The geometry to accelerate.
+ * @returns Returns `true` if the geometry was successfully accelerated.
+ */
 export function accelerateGeometry(geometry: GeometryUnion): boolean;
 
 /**
@@ -25,7 +34,20 @@ export function accelerateGeometry(geometry: GeometryUnion): boolean;
  * @returns Returns `true` if `geometry1` contains `geometry2`.
  * @example
  * // Returns true if one geometry contains another
- * const isContained = containsOperator.execute(polygon1, polygon2);
+ * const isContained = containsExecute(polygon1, polygon2);
+ */
+export function containsExecute(geometry1: GeometryUnion, geometry2: GeometryUnion): boolean;
+
+/**
+ * Perform the contains operation on two geometries.
+ *
+ * @deprecated since 5.2 use [containsExecute()](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/containsOperator/#containsExecute)
+ * @param geometry1 - The geometry that is tested for the "contains" relationship to `geometry2`.
+ * @param geometry2 - The geometry that is tested for the "within" relationship to `geometry1`.
+ * @returns Returns `true` if `geometry1` contains `geometry2`.
+ * @example
+ * // Returns true if one geometry contains another
+ * const isContained = containsExecute(polygon1, polygon2);
  */
 export function execute(geometry1: GeometryUnion, geometry2: GeometryUnion): boolean;
 
@@ -33,4 +55,12 @@ export function execute(geometry1: GeometryUnion, geometry2: GeometryUnion): boo
  * Indicates if the operator supports input geometries that contain curves.
  * The value will always be `true`.
  */
-export const supportsCurves: boolean;
+export const containsSupportsCurves: boolean;
+
+/**
+ * Indicates if the operator supports input geometries that contain curves.
+ * The value will always be `true`.
+ *
+ * @deprecated since 5.2 use [containsSupportsCurves](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/containsOperator/#containsSupportsCurves)
+ */
+export const supportsCurves: ReturnType<typeof Boolean>;

package/geometry/operators/containsOperator.js

@@ -1,2 +1,2 @@
 /* COPYRIGHT Esri - https://js.arcgis.com/5.2/LICENSE.txt */
-import{x as e}from"../../chunks/UnitFactory.js";import{fromGeometry as t,fromSpatialReference as r,getSpatialReference as n}from"./support/apiConverter.js";const o=new e;function s(e){const s=n(e);return o.accelerateGeometry(t(e),r(s),1)}function c(e,n){return o.execute(t(e),t(n),r(e.spatialReference),null)}const u=o.supportsCurves();export{s as accelerateGeometry,c as execute,u as supportsCurves};
+import{x as e}from"../../chunks/UnitFactory.js";import{deprecatedFunction as r}from"../../core/deprecate.js";import t from"../../core/Logger.js";import{fromGeometry as o,fromSpatialReference as n,getSpatialReference as c}from"./support/apiConverter.js";const a=new e;function s(e){const r=c(e);return a.accelerateGeometry(o(e),n(r),1)}function i(e){return r(t.getLogger("esri.geometry.operators.containsOperator"),"accelerateGeometry is deprecated. Use containsAccelerateGeometry instead.",{replacement:"containsAccelerateGeometry",warnOnce:!0}),s(e)}function p(e,r){return a.execute(o(e),o(r),n(e.spatialReference),null)}function u(e,o){return r(t.getLogger("esri.geometry.operators.containsOperator"),"execute is deprecated. Use containsExecute instead.",{replacement:"containsExecute",warnOnce:!0}),p(e,o)}const m=a.supportsCurves(),g=Boolean(m);export{i as accelerateGeometry,s as containsAccelerateGeometry,p as containsExecute,m as containsSupportsCurves,u as execute,g as supportsCurves};

package/geometry/operators/convexHullOperator.d.ts

@@ -9,7 +9,7 @@
  */
 import type { GeometryUnion, GeometryWithoutMeshUnion } from "../types.js";
 
-export interface Options {
+export interface ConvexHullOptions {
   /**
    * Indicates if the convex hull geometries should be merged.
    * Set to `true` to merge the geometries into a single geometry.
@@ -19,14 +19,29 @@ export interface Options {
   merge?: boolean;
 }
 
+/** @deprecated since 5.2 use [ConvexHullOptions](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/convexHullOperator/#ConvexHullOptions) */
+export type Options = ConvexHullOptions;
+
+/**
+ * Calculates the convex hull geometry.
+ *
+ * @param geometry - The input geometry.
+ * @returns Returns the convex hull geometry or null.
+ * @example
+ * // Create a convex hull around a polygon.
+ * const convexHull = convexHullExecute(polygon);
+ */
+export function convexHullExecute(geometry: GeometryUnion): GeometryWithoutMeshUnion | null | undefined;
+
 /**
  * Calculates the convex hull geometry.
  *
+ * @deprecated since 5.2 use [convexHullExecute()](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/convexHullOperator/#convexHullExecute)
  * @param geometry - The input geometry.
  * @returns Returns the convex hull geometry or null.
  * @example
  * // Create a convex hull around a polygon.
- * const convexHull = convexHullOperator.execute(polygon);
+ * const convexHull = convexHullExecute(polygon);
  */
 export function execute(geometry: GeometryUnion): GeometryWithoutMeshUnion | null | undefined;
 
@@ -38,11 +53,31 @@ export function execute(geometry: GeometryUnion): GeometryWithoutMeshUnion | nul
  * @param options - Additional options.
  * @returns Returns the convex hull geometries or null.
  */
-export function executeMany(geometries: GeometryUnion[], options?: Options): (GeometryWithoutMeshUnion | null | undefined)[];
+export function convexHullExecuteMany(geometries: GeometryUnion[], options?: ConvexHullOptions): (GeometryWithoutMeshUnion | null | undefined)[];
+
+/**
+ * Calculates the convex hull.
+ *
+ * @deprecated since 5.2 use [convexHullExecuteMany()](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/convexHullOperator/#convexHullExecuteMany)
+ * @param geometries - The input geometries.
+ * All the geometries must have the same spatial reference.
+ * @param options - Additional options.
+ * @returns Returns the convex hull geometries or null.
+ */
+export function executeMany(geometries: GeometryUnion[], options?: ConvexHullOptions): (GeometryWithoutMeshUnion | null | undefined)[];
+
+/**
+ * Checks if a geometry is convex.
+ *
+ * @param geometry - The input geometry.
+ * @returns Returns `true` if the geometry is convex.
+ */
+export function convexHullIsConvex(geometry: GeometryUnion): boolean;
 
 /**
  * Checks if a geometry is convex.
  *
+ * @deprecated since 5.2 use [convexHullIsConvex()](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/convexHullOperator/#convexHullIsConvex)
  * @param geometry - The input geometry.
  * @returns Returns `true` if the geometry is convex.
  */
@@ -52,4 +87,12 @@ export function isConvex(geometry: GeometryUnion): boolean;
  * Indicates if the operator supports input geometries that contain curves.
  * The value will always be `true`.
  */
-export const supportsCurves: boolean;
+export const convexHullSupportsCurves: boolean;
+
+/**
+ * Indicates if the operator supports input geometries that contain curves.
+ * The value will always be `true`.
+ *
+ * @deprecated since 5.2 use [convexHullSupportsCurves](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/convexHullOperator/#convexHullSupportsCurves)
+ */
+export const supportsCurves: ReturnType<typeof Boolean>;

package/geometry/operators/convexHullOperator.js

@@ -1,2 +1,2 @@
 /* COPYRIGHT Esri - https://js.arcgis.com/5.2/LICENSE.txt */
-import{supportsCurves as r,execute as e,executeMany as o,isConvex as t}from"./gx/operatorConvexHull.js";import{getSpatialReference as n,toGeometry as s,fromGeometry as u}from"./support/apiConverter.js";function p(r){const o=n(r);return s(e(u(r)),o)}function a(r,e={}){const{merge:t=!1}=e,p=r.map(u),a=n(r);return o(p,t).map(r=>s(r,a))}function c(r){return t(u(r))}const i=r();export{p as execute,a as executeMany,c as isConvex,i as supportsCurves};
+import{deprecatedFunction as e}from"../../core/deprecate.js";import r from"../../core/Logger.js";import{supportsCurves as o,execute as t,executeMany as n,isConvex as c}from"./gx/operatorConvexHull.js";import{getSpatialReference as s,toGeometry as u,fromGeometry as a}from"./support/apiConverter.js";function p(e){const r=s(e);return u(t(a(e)),r)}function l(o){return e(r.getLogger("esri.geometry.operators.convexHullOperator"),"execute is deprecated. Use convexHullExecute instead.",{replacement:"convexHullExecute",warnOnce:!0}),p(o)}function x(e,r={}){const{merge:o=!1}=r,t=e.map(a),c=s(e);return n(t,o).map(e=>u(e,c))}function i(o,t={}){return e(r.getLogger("esri.geometry.operators.convexHullOperator"),"executeMany is deprecated. Use convexHullExecuteMany instead.",{replacement:"convexHullExecuteMany",warnOnce:!0}),x(o,t)}function m(e){return c(a(e))}function g(o){return e(r.getLogger("esri.geometry.operators.convexHullOperator"),"isConvex is deprecated. Use convexHullIsConvex instead.",{replacement:"convexHullIsConvex",warnOnce:!0}),m(o)}const v=o(),d=Boolean(v);export{p as convexHullExecute,x as convexHullExecuteMany,m as convexHullIsConvex,v as convexHullSupportsCurves,l as execute,i as executeMany,g as isConvex,d as supportsCurves};

package/geometry/operators/crossesOperator.d.ts

@@ -13,6 +13,15 @@ import type { GeometryUnion } from "../types.js";
  * @param geometry - The geometry to accelerate.
  * @returns Returns `true` if the geometry was successfully accelerated.
  */
+export function crossesAccelerateGeometry(geometry: GeometryUnion): boolean;
+
+/**
+ * Accelerate a geometry. This method prepares the geometry for faster crosses operations when the same geometry is tested multiple times (e.g. in a loop with hundreds of iterations). See the [Acceleration](https://developers.arcgis.com/javascript/latest/spatial-analysis/intro-geometry-operators/#acceleration) guide topic for more information.
+ *
+ * @deprecated since 5.2 use [crossesAccelerateGeometry()](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/crossesOperator/#crossesAccelerateGeometry)
+ * @param geometry - The geometry to accelerate.
+ * @returns Returns `true` if the geometry was successfully accelerated.
+ */
 export function accelerateGeometry(geometry: GeometryUnion): boolean;
 
 /**
@@ -26,7 +35,23 @@ export function accelerateGeometry(geometry: GeometryUnion): boolean;
  * @returns Returns `true` if `geometry1` crosses `geometry2`.
  * @example
  * // Returns true if a geometry crosses another geometry
- * const isCrossed = crossesOperator.execute(polygon, polyline);
+ * const isCrossed = crossesExecute(polygon, polyline);
+ */
+export function crossesExecute(geometry1: GeometryUnion, geometry2: GeometryUnion): boolean;
+
+/**
+ * Perform the crosses operation on two geometries.
+ * This relation is true when geometries have some but not all interior points in common.
+ * The interiors must intersect and produce a geometry of smaller dimension than the maximum dimension of the two geometries.
+ * This relation may return true only between polygon and polyline, polygon and point, polyline and polyline, and polyline and point.
+ *
+ * @deprecated since 5.2 use [crossesExecute()](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/crossesOperator/#crossesExecute)
+ * @param geometry1 - The geometry to cross.
+ * @param geometry2 - The geometry being crossed.
+ * @returns Returns `true` if `geometry1` crosses `geometry2`.
+ * @example
+ * // Returns true if a geometry crosses another geometry
+ * const isCrossed = crossesExecute(polygon, polyline);
  */
 export function execute(geometry1: GeometryUnion, geometry2: GeometryUnion): boolean;
 
@@ -34,4 +59,12 @@ export function execute(geometry1: GeometryUnion, geometry2: GeometryUnion): boo
  * Indicates if the operator supports input geometries that contain curves.
  * The value will always be `true`.
  */
-export const supportsCurves: boolean;
+export const crossesSupportsCurves: boolean;
+
+/**
+ * Indicates if the operator supports input geometries that contain curves.
+ * The value will always be `true`.
+ *
+ * @deprecated since 5.2 use [crossesSupportsCurves](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/crossesOperator/#crossesSupportsCurves)
+ */
+export const supportsCurves: ReturnType<typeof Boolean>;

package/geometry/operators/crossesOperator.js

@@ -1,2 +1,2 @@
 /* COPYRIGHT Esri - https://js.arcgis.com/5.2/LICENSE.txt */
-import{OperatorCrosses as e}from"../../chunks/OperatorCrosses.js";import{getSpatialReference as r,fromGeometry as t,fromSpatialReference as o}from"./support/apiConverter.js";const n=new e;function s(e){const s=r(e);return n.accelerateGeometry(t(e),o(s),1)}function c(e,r){return n.execute(t(e),t(r),o(e.spatialReference),null)}const p=n.supportsCurves();export{s as accelerateGeometry,c as execute,p as supportsCurves};
+import{OperatorCrosses as e}from"../../chunks/OperatorCrosses.js";import{deprecatedFunction as r}from"../../core/deprecate.js";import t from"../../core/Logger.js";import{getSpatialReference as o,fromGeometry as s,fromSpatialReference as c}from"./support/apiConverter.js";const n=new e;function a(e){const r=o(e);return n.accelerateGeometry(s(e),c(r),1)}function p(e){return r(t.getLogger("esri.geometry.operators.crossesOperator"),"accelerateGeometry is deprecated. Use crossesAccelerateGeometry instead.",{replacement:"crossesAccelerateGeometry",warnOnce:!0}),a(e)}function u(e,r){return n.execute(s(e),s(r),c(e.spatialReference),null)}function i(e,o){return r(t.getLogger("esri.geometry.operators.crossesOperator"),"execute is deprecated. Use crossesExecute instead.",{replacement:"crossesExecute",warnOnce:!0}),u(e,o)}const m=n.supportsCurves(),g=Boolean(m);export{p as accelerateGeometry,a as crossesAccelerateGeometry,u as crossesExecute,m as crossesSupportsCurves,i as execute,g as supportsCurves};

package/geometry/operators/cutOperator.d.ts

@@ -27,7 +27,20 @@ import type { GeometryUnion, GeometryWithoutMeshUnion } from "../types.js";
  * @returns Returns an array of geometries created by cutting the input geometry with the `polyline`.
  * @example
  * // Cut a polygon with a polyline
- * const cutGeometries = cutOperator.execute(polygon, polyline);
+ * const cutGeometries = cutExecute(polygon, polyline);
+ */
+export function cutExecute(geometry: GeometryUnion, polyline: Polyline): GeometryWithoutMeshUnion[];
+
+/**
+ * Performs the cut operation on a geometry.
+ *
+ * @deprecated since 5.2 use [cutExecute()](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/cutOperator/#cutExecute)
+ * @param geometry - The input geometry to be cut.
+ * @param polyline - The polyline that will be used to divide the input `geometry` into pieces where they cross the `polyline`.
+ * @returns Returns an array of geometries created by cutting the input geometry with the `polyline`.
+ * @example
+ * // Cut a polygon with a polyline
+ * const cutGeometries = cutExecute(polygon, polyline);
  */
 export function execute(geometry: GeometryUnion, polyline: Polyline): GeometryWithoutMeshUnion[];
 
@@ -35,4 +48,12 @@ export function execute(geometry: GeometryUnion, polyline: Polyline): GeometryWi
  * Indicates if the operator supports input geometries that contain curves.
  * The value will always be `true`.
  */
-export const supportsCurves: boolean;
+export const cutSupportsCurves: boolean;
+
+/**
+ * Indicates if the operator supports input geometries that contain curves.
+ * The value will always be `true`.
+ *
+ * @deprecated since 5.2 use [cutSupportsCurves](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/cutOperator/#cutSupportsCurves)
+ */
+export const supportsCurves: ReturnType<typeof Boolean>;

package/geometry/operators/cutOperator.js

@@ -1,2 +1,2 @@
 /* COPYRIGHT Esri - https://js.arcgis.com/5.2/LICENSE.txt */
-import{isSome as r}from"../../core/arrayUtils.js";import{supportsCurves as o,execute as t}from"./gx/operatorCut.js";import{getSpatialReference as s,fromSpatialReference as e,fromPolyline as p,fromGeometry as a,toGeometry as i}from"./support/apiConverter.js";function m(o,m){const u=s(o);return t(a(o),p(m),e(u)).map(r=>i(r,u)).filter(r)}const u=o();export{m as execute,u as supportsCurves};
+import{isSome as e}from"../../core/arrayUtils.js";import{deprecatedFunction as r}from"../../core/deprecate.js";import t from"../../core/Logger.js";import{supportsCurves as o,execute as s}from"./gx/operatorCut.js";import{getSpatialReference as c,fromSpatialReference as p,fromPolyline as a,fromGeometry as u,toGeometry as n}from"./support/apiConverter.js";function i(r,t){const o=c(r);return s(u(r),a(t),p(o)).map(e=>n(e,o)).filter(e)}function m(e,o){return r(t.getLogger("esri.geometry.operators.cutOperator"),"execute is deprecated. Use cutExecute instead.",{replacement:"cutExecute",warnOnce:!0}),i(e,o)}const f=o(),g=Boolean(f);export{i as cutExecute,f as cutSupportsCurves,m as execute,g as supportsCurves};