@arcgis/core 5.0.0-next.54 → 5.0.0-next.56

package/core/scheduling.d.ts

@@ -1,17 +1,38 @@
+/**
+ * Various utilities and convenience functions for executing code at various phases of browser frames.
+ * The scheduling module allows you to register tasks that are executed in every animation frame. This
+ * can be used to synchronize updates with ongoing animations of the view, or to animate the view
+ * manually by adjusting the extent or camera in every frame.
+ *
+ * ```js
+ * // Animate the scene view camera heading in every frame
+ * let handle = scheduling.addFrameTask({
+ *   update: function() {
+ *     let camera = view.camera.clone();
+ *     camera.heading += 0.2;
+ *     view.camera = camera;
+ *   }
+ * });
+ *
+ * // Remove frame task as soon as the user starts navigating in the view
+ * reactiveUtils.whenOnce(() => view.navigating, () => handle.remove());
+ * ```
+ *
+ * @since 4.7
+ */
 import type { ResourceHandle } from "./Handles.js";
-import type { Milliseconds } from "./time.js";
 
 /** An object with timing information. */
 export interface PhaseEvent {
   /** The elapsed time since the last animation frame. */
-  deltaTime: Milliseconds;
+  deltaTime: number;
   /**
    * The amount of time spent within the current animation frame.
    *                                       This can be used for budgeting (e.g. some tasks may already have run).
    */
-  elapsedFrameTime: Milliseconds;
+  elapsedFrameTime: number;
   /** The absolute time at the start of the current animation frame. */
-  time: Milliseconds;
+  time: number;
 }
 
 /**
@@ -35,7 +56,7 @@ export interface PhaseCallbacks {
 export type PhaseCallback = (event: PhaseEvent) => void;
 
 /** An object to remove or pause a frame task registered with [addFrameTask()](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-scheduling.html#addFrameTask). */
-export abstract class FrameTaskHandle {
+export interface FrameTaskHandle {
   /** Pause the execution the frame task at every frame. */
   pause(): void;
   /** Removes the frame task. */

package/core/scheduling.js

@@ -2,4 +2,4 @@
 All material copyright Esri, All Rights Reserved, unless otherwise specified.
 See https://js.arcgis.com/5.0/esri/copyright.txt for details.
 */
-import{nextTick as e}from"./nextTick.js";import{recordPerformance as t}from"./performance.js";import n from"./PerformanceSampler.js";import r from"./PooledArray.js";import{createResolver as s,isAborted as o,createAbortError as a}from"./promiseUtils.js";import{Milliseconds as i}from"./time.js";class c{constructor(e){this.phases=e,this.paused=!1,this.ticks=-1,this.removed=!1}}class m{constructor(e){this.callback=e,this.isActive=!0}remove(){this.isActive=!1}}let u=0,l=0;const p={time:i(0),deltaTime:i(0),elapsedFrameTime:i(0),frameDuration:i(0)},f=["prepare","preRender","render","postRender","update","finish"],h=[],d=new r;class w{constructor(e){this._task=e}remove(){this._task.removed=!0}pause(){this._task.paused=!0}resume(){this._task.paused=!1,v()}}function k(){null!=D&&(cancelAnimationFrame(D),D=requestAnimationFrame(g))}function v(){null==D&&(u=performance.now(),D=requestAnimationFrame(g))}const A={frameTasks:d,willDispatch:!1,clearFrameTasks:j,dispatch:b,executeFrameTasks:M,reschedule:k};function F(t){const n=new m(t);return h.push(n),A.willDispatch||(A.willDispatch=!0,e(b)),n}function T(e){const t=new c(e);return d.push(t),v(),new w(t)}let D=null;function j(e=!1){d.forAll(e=>{e.removed=!0}),e&&q()}function x(e){l=Math.max(0,e)}function g(){const e=performance.now();D=null;const t=d.some(e=>!e.paused&&!e.removed);D=t?requestAnimationFrame(g):null,A.executeFrameTasks(e)}function M(e){const n=i(e-u);u=e;const r=l>0?l:1e3/60,s=Math.max(0,n-r);p.time=e,p.frameDuration=i(r-s);for(let a=0;a<f.length;a++){const r=performance.now(),s=f[a];d.forAll(t=>{if(t.paused||t.removed)return;0===a&&t.ticks++;t.phases[s]&&(p.elapsedFrameTime=i(performance.now()-e),p.deltaTime=0===t.ticks?i(0):n,t.phases[s]?.call(t,p))});const o=performance.now();U[a].push(o-r),t(s,r,o,"Maps SDK","Scheduling")}q();const o=performance.now();z.push(o-e),t("Animation Frame",e,o,"Maps SDK","Scheduling")}const S=new r;function q(){d.forAll(e=>{e.removed&&S.push(e)}),d.removeUnorderedMany(S.data,S.length),S.clear()}function _(){d.prune(),S.prune()}function b(){for(;h.length;){const e=h.shift();e.isActive&&e.callback()}A.willDispatch=!1}function y(t=1,n){const r=s(),i=()=>{o(n)?r.reject(a()):0===t?r():(--t,e(()=>i()))};return i(),r.promise}function P(e){return y(1,e)}function R(){const e=s(),t=T({postRender:()=>{t.remove(),F(e)}});return e.promise}async function K(e){await P(e),await new Promise(t=>requestAnimationFrame(()=>{e?.aborted||t()}))}const U=f.map(e=>new n(e)),z=new n("total");export{w as FrameTaskHandle,T as addFrameTask,_ as cleanupScheduling,A as debug,U as performanceInfo,z as performanceTotal,F as schedule,x as setFrameDuration,K as waitAnimationFrame,R as waitRender,P as waitTick,y as waitTicks};
+import{nextTick as e}from"./nextTick.js";import{recordPerformance as t}from"./performance.js";import n from"./PerformanceSampler.js";import r from"./PooledArray.js";import{createResolver as s,isAborted as o,createAbortError as a}from"./promiseUtils.js";import{Milliseconds as i}from"./time.js";class c{constructor(e){this.phases=e,this.paused=!1,this.ticks=-1,this.removed=!1}}class m{constructor(e){this.callback=e,this.isActive=!0}remove(){this.isActive=!1}}let u=0,l=0;const p={time:i(0),deltaTime:i(0),elapsedFrameTime:i(0),frameDuration:i(0)},f=["prepare","preRender","render","postRender","update","finish"],h=[],d=new r;class w{constructor(e){this._task=e}remove(){this._task.removed=!0}pause(){this._task.paused=!0}resume(){this._task.paused=!1,v()}}function k(){null!=D&&(cancelAnimationFrame(D),D=requestAnimationFrame(g))}function v(){null==D&&(u=performance.now(),D=requestAnimationFrame(g))}const A={frameTasks:d,willDispatch:!1,clearFrameTasks:j,dispatch:b,executeFrameTasks:M,reschedule:k};function F(t){const n=new m(t);return h.push(n),A.willDispatch||(A.willDispatch=!0,e(b)),n}function T(e){const t=new c(e);return d.push(t),v(),new w(t)}let D=null;function j(e=!1){d.forAll(e=>{e.removed=!0}),e&&q()}function x(e){l=Math.max(0,e)}function g(){const e=performance.now();D=null;const t=d.some(e=>!e.paused&&!e.removed);D=t?requestAnimationFrame(g):null,A.executeFrameTasks(e)}function M(e){const n=i(e-u);u=e;const r=l>0?l:1e3/60,s=Math.max(0,n-r);p.time=e,p.frameDuration=i(r-s);for(let a=0;a<f.length;a++){const r=performance.now(),s=f[a];d.forAll(t=>{if(t.paused||t.removed)return;0===a&&t.ticks++;t.phases[s]&&(p.elapsedFrameTime=i(performance.now()-e),p.deltaTime=0===t.ticks?i(0):n,t.phases[s]?.call(t,p))});const o=performance.now();U[a].push(o-r),t(s,r,o,"Maps SDK","Scheduling")}q();const o=performance.now();z.push(o-e),t("Animation Frame",e,o,"Maps SDK","Scheduling")}const S=new r;function q(){d.forAll(e=>{e.removed&&S.push(e)}),d.removeUnorderedMany(S.data,S.length),S.clear()}function _(){d.prune(),S.prune()}function b(){for(;h.length;){const e=h.shift();e.isActive&&e.callback()}A.willDispatch=!1}function y(t=1,n){const r=s(),i=()=>{o(n)?r.reject(a()):0===t?r():(--t,e(()=>i()))};return i(),r.promise}function P(e){return y(1,e)}function R(){const e=s(),t=T({postRender:()=>{t.remove(),F(e)}});return e.promise}async function K(e){await P(e),await new Promise(t=>requestAnimationFrame(()=>{e?.aborted||t()}))}const U=f.map(e=>new n(e)),z=new n("total");export{T as addFrameTask,_ as cleanupScheduling,A as debug,U as performanceInfo,z as performanceTotal,F as schedule,x as setFrameDuration,K as waitAnimationFrame,R as waitRender,P as waitTick,y as waitTicks};

package/core/sql/WhereClause.d.ts

@@ -1,11 +1,4 @@
-import type { SQLSourceLocation } from "./sql92grammar.js";
-import type { SQLNode } from "./WhereGrammar.js";
-
-export interface SQLSyntaxError extends Error {
-  location: SQLSourceLocation;
-  message: string;
-  name: "SyntaxError";
-}
+import type { SimpleAttributes, SQLNode } from "./types.js";
 
 /**
  * The WhereClause is used to extract the features that meet a specified condition by parsing the provided
@@ -88,8 +81,4 @@ export default abstract class WhereClause {
    * });
    */
   testFeature(feature: SimpleAttributes): boolean;
-}
-
-export type SimpleAttributes = {
-    attributes: Record<string, unknown>;
-} | Record<string, any>;
+}

package/core/sql/{WhereGrammar.d.ts → types.d.ts}

@@ -1,4 +1,25 @@
-import type { SQLSourceLocation } from "./sql92grammar.js";
+
+export interface SourcePosition {
+  column: number;
+  line: number;
+  offset: number;
+}
+
+export interface SQLSourceLocation {
+  end: SourcePosition;
+  source?: unknown;
+  start: SourcePosition;
+}
+
+export interface SQLSyntaxError extends Error {
+  location: SQLSourceLocation;
+  message: string;
+  name: "SyntaxError";
+}
+
+export type SimpleAttributes = {
+    attributes: Record<string, unknown>;
+} | Record<string, any>;
 
 /**
  * SQL parse tree is composed of SqlNodes. It may be an operator, literal, function, list, and so forth.

package/core/sql.d.ts

@@ -1,3 +1,11 @@
+/**
+ * Creates a [WhereClause](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-sql-WhereClause.html) expression that adheres to standardized SQL expressions.
+ * SQL expression is a combination of one or more values, operators and SQL functions that
+ * results in to a value.
+ *
+ * @since 4.14
+ * @see [Standardized SQL functions in ArcGIS Online](https://doc.arcgis.com/en/arcgis-online/reference/sql-agol.htm)
+ */
 import type WhereClause from "./sql/WhereClause.js";
 import type FieldsIndex from "../layers/support/FieldsIndex.js";
 

package/core/string.js

@@ -2,4 +2,4 @@
 All material copyright Esri, All Rights Reserved, unless otherwise specified.
 See https://js.arcgis.com/5.0/esri/copyright.txt for details.
 */
-import{getDeepValue as t}from"./object.js";const e=/\{([^}]+)\}/g;function n(t){return t??""}function r(r,o){return o?r.replaceAll(e,"object"==typeof o?(e,r)=>n(t(r,o)):(t,e)=>n(o(e))):r}function o(t,e){return t.replaceAll(/([.$?*|{}()[\]\\/+\-^])/g,t=>e?.includes(t)?t:`\\${t}`)}function l(t){let e=0;for(let n=0;n<t.length;n++)e=(e<<5)-e+t.charCodeAt(n),e|=0;return e}let u;function c(t){u??=new DOMParser;return u.parseFromString(t||"","text/html").body.innerText||""}function i(t,e){return new RegExp(`{${e}}`,"ig").test(t)}function f(t,...e){let n=t[0];for(let r=0;r<e.length;++r)n+=e[r]+t[r+1];return n}export{o as escapeRegExpString,l as numericHash,r as replace,f as safeToString,c as stripHTML,i as templateHasKey};
+import{getDeepValue as t}from"./object.js";const e=/\{([^}]+)\}/g;function n(t){return t??""}function r(r,o){return o?r.replaceAll(e,"object"==typeof o?(e,r)=>n(t(r,o)):(t,e)=>n(o(e))):r}function o(e,n){return e.replaceAll(/\$\{([^\s:}]*)(?::([^\s:}]+))?\}/g,(e,r)=>{if(""===r)return"$";const o=t(r,n);return(o??"").toString()})}function u(t,e){return t.replaceAll(/([.$?*|{}()[\]\\/+\-^])/g,t=>e?.includes(t)?t:`\\${t}`)}function l(t){let e=0;for(let n=0;n<t.length;n++)e=(e<<5)-e+t.charCodeAt(n),e|=0;return e}let c;function i(t){c??=new DOMParser;return c.parseFromString(t||"","text/html").body.innerText||""}function f(t,e){return new RegExp(`{${e}}`,"ig").test(t)}function g(t,...e){let n=t[0];for(let r=0;r<e.length;++r)n+=e[r]+t[r+1];return n}export{u as escapeRegExpString,l as numericHash,r as replace,g as safeToString,i as stripHTML,o as substitute,f as templateHasKey};

package/core/types.d.ts

@@ -23,4 +23,33 @@ export interface ScreenPoint {
   x: number;
   /** The y coordinate in pixels. */
   y: number;
-}
+}
+
+/**
+ * A custom log interceptor function.
+ *
+ * @param level - The level of the message.
+ * @param module - The module from which the log message originated.
+ * @param args - Arguments of any type to be logged.
+ * @returns Return true to indicate the log message has been handled and should no longer be processed
+ * (neither by other interceptors nor by the default handler which logs messages to the console).
+ * @example
+ * // Only show error messages, not warnings nor info messages
+ * esriConfig.log.level = "error";
+ *
+ * esriConfig.log.interceptors.push(function(level, module, ...args) {
+ *   // Send all messages to a REST end-point
+ *   request(loggingUrl, {
+ *     method: "post",
+ *     body: {
+ *             level: level,
+ *             module: module,
+ *             details: JSON.stringify(args)
+ *           }
+ *   });
+ *
+ *   // Return false so that the default log handler still writes log messages to the console
+ *   return false;
+ * });
+ */
+export type LogInterceptor = (level: "error" | "warn" | "info", module: string, ...args: any[]) => boolean;

package/core/units.d.ts

@@ -1,3 +1,8 @@
+/**
+ * Types of units used across the JS API.
+ *
+ * @since 4.18
+ */
 
 export type APIUnitString = "millimeters" | "centimeters" | "meters" | "feet" | "us-feet" | "clarke-feet" | "fathoms" | "nautical-miles" | "german-meters" | "us-chains" | "us-links" | "us-miles" | "kilometers" | "clarke-yards" | "clarke-chains" | "clarke-links" | "sears-yards" | "sears-feet" | "sears-chains" | "sears-links" | "benoit-1895-a-yards" | "benoit-1895-a-feet" | "benoit-1895-a-chains" | "benoit-1895-a-links" | "benoit-1895-b-yards" | "benoit-1895-b-feet" | "benoit-1895-b-chains" | "benoit-1895-b-links" | "1865-feet" | "indian-feet" | "indian-1937-feet" | "indian-1962-feet" | "indian-1975-feet" | "indian-yards" | "indian-1937-yards" | "indian-1962-yards" | "indian-1975-yards" | "statute-miles" | "gold-coast-feet" | "british-1936-feet" | "yards" | "chains" | "links" | "sears-1922-truncated-yards" | "sears-1922-truncated-feet" | "sears-1922-truncated-chains" | "sears-1922-truncated-links" | "us-yards" | "decimeters" | "inches" | "us-inches" | "rods" | "us-rods" | "us-nautical-miles" | "uk-nautical-miles" | "smoots" | "tx-vara" | "points" | "micrometers" | "nanometers" | "50-kilometers" | "150-kilometers";
 
@@ -16,6 +21,9 @@ export type ElevationUnit = "unknown" | "inches" | "feet" | "us-feet" | "yards"
 /** Units for angles. */
 export type AngleUnit = "degrees" | "radians";
 
+/** Units for time. */
+export type TimeUnit = "milliseconds" | "seconds" | "minutes" | "hours" | "days" | "weeks" | "months" | "years" | "decades" | "centuries";
+
 /** Units for angles. */
 export type Unit = LengthUnit | AreaUnit | VolumeUnit | AngleUnit;
 

package/core/urlUtils.d.ts

@@ -1,3 +1,10 @@
+/**
+ * Utility methods for working with URLs.
+ *
+ * @since 4.0
+ * @see [esriConfig.request](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#ConfigWithRequest)
+ * @see [Guide topic - Proxy pages](https://developers.arcgis.com/javascript/latest/proxies/)
+ */
 
 /**
  * Converts the URL arguments to an object representation.

package/core/workers/loaderConfig.js

@@ -2,4 +2,4 @@
 All material copyright Esri, All Rights Reserved, unless otherwise specified.
 See https://js.arcgis.com/5.0/esri/copyright.txt for details.
 */
-import"../../config.js";import"../../request.js";import"../Error.js";import"../Logger.js";import"../urlUtils.js";import"../has.js";let s=null;const a={};function r(s){const r={async:s.async,isDebug:s.isDebug,locale:s.locale,baseUrl:s.baseUrl,has:{...s.has},map:{...s.map},packages:s.packages?.slice()||[],paths:{...a.paths,...s.paths}};return s.hasOwnProperty("async")||(r.async=!0),s.hasOwnProperty("isDebug")||(r.isDebug=!1),s.baseUrl||(r.baseUrl=a.baseUrl),r}export{s as defaultLoaderUrl,r as loaderConfig};
+import"../../config.js";import"../../request.js";import"../has.js";import"../RandomLCG.js";import"../Logger.js";import"../urlUtils.js";let s=null;const a={};function e(s){const e={async:s.async,isDebug:s.isDebug,locale:s.locale,baseUrl:s.baseUrl,has:{...s.has},map:{...s.map},packages:s.packages?.slice()||[],paths:{...a.paths,...s.paths}};return s.hasOwnProperty("async")||(e.async=!0),s.hasOwnProperty("isDebug")||(e.isDebug=!1),s.baseUrl||(e.baseUrl=a.baseUrl),e}export{s as defaultLoaderUrl,e as loaderConfig};

package/core/workers/workerFactory.js

@@ -2,4 +2,4 @@
 All material copyright Esri, All Rights Reserved, unless otherwise specified.
 See https://js.arcgis.com/5.0/esri/copyright.txt for details.
 */
-import{getAssetUrl as e}from"../../assets.js";import r from"../../config.js";import{getLocale as t}from"../../intl.js";import{fullVersion as o}from"../../kernel.js";import has from"../has.js";import s from"../Logger.js";import{makeAbsolute as a}from"../urlUtils.js";import{loaderConfig as n}from"./loaderConfig.js";import{receiveMessage as i,MessageType as l}from"./utils.js";import f from"./WorkerFallback.js";import{commitHash as u,buildDate as c}from"../../support/revision.js";const d=()=>s.getLogger("esri.core.workers.workerFactory"),{HANDSHAKE:m}=l,p='let globalId=0;const outgoing=new Map,configuration={CONFIGURATION};self.esriConfig=configuration.esriConfig;const workerPath=self.esriConfig.workers.workerPath,HANDSHAKE=0,OPEN=1,OPENED=2,RESPONSE=3,INVOKE=4,ABORT=5;function createAbortError(){const e=new Error("Aborted");return e.name="AbortError",e}function receiveMessage(e){return e&&e.data?"string"==typeof e.data?JSON.parse(e.data):e.data:null}function invokeStaticMessage(e,o,r){const t=r&&r.signal,n=globalId++;let s=null;return new Promise((r,i)=>{if(t){if(t.aborted)return i(createAbortError());s=()=>{outgoing.get(n)&&(outgoing.delete(n),self.postMessage({type:5,jobId:n}),i(createAbortError()))},t.addEventListener("abort",s)}outgoing.set(n,{resolve:r,reject:i}),self.postMessage({type:4,jobId:n,methodName:e,abortable:null!=t,data:o})}).finally(()=>{t&&t.removeEventListener("abort",s)})}let workerRevisionChecked=!1;function checkWorkerRevision(e){if(!workerRevisionChecked&&e.kernelInfo){workerRevisionChecked=!0;const{revision:o,fullVersion:r}=configuration.kernelInfo,{revision:t,fullVersion:n,version:s}=e.kernelInfo;esriConfig.assetsPath!==esriConfig.defaultAssetsPath&&o!==t&&console.warn(`Version mismatch detected between ArcGIS Maps SDK for JavaScript modules and assets. For more information visit https://esriurl.com/using-local-assets.\nModules version: ${r}\nAssets version: ${n??s}\nAssets path: ${esriConfig.assetsPath}`)}}function messageHandler(e){const o=receiveMessage(e);if(!o)return;const r=o.jobId;switch(o.type){case 1:let n;function t(e){const o=n.connect(e);self.postMessage({type:2,jobId:r,data:o},[o])}"function"==typeof define&&define.amd?require([workerPath],e=>{n=e.default||e,checkWorkerRevision(n),n.loadWorker(o.modulePath).then(e=>e||new Promise(e=>{require([o.modulePath],e)})).then(t)}):"System"in self&&"function"==typeof System.import?System.import(workerPath).then(e=>(n=e.default,checkWorkerRevision(n),n.loadWorker(o.modulePath))).then(e=>e||System.import(o.modulePath)).then(t):esriConfig.workers.useDynamicImport?import(workerPath).then(e=>{n=e.default||e,checkWorkerRevision(n),n.loadWorker(o.modulePath).then(e=>e||import(o.modulePath)).then(t)}):(self.RemoteClient||importScripts(workerPath),n=self.RemoteClient.default||self.RemoteClient,checkWorkerRevision(n),n.loadWorker(o.modulePath).then(t));break;case 3:if(outgoing.has(r)){const s=outgoing.get(r);outgoing.delete(r),o.error?s.reject(JSON.parse(o.error)):s.resolve(o.data)}}}self.dojoConfig=configuration.loaderConfig,esriConfig.workers.loaderUrl&&(self.importScripts(esriConfig.workers.loaderUrl),"function"==typeof require&&"function"==typeof require.config&&require.config(configuration.loaderConfig)),self.addEventListener("message",messageHandler),self.postMessage({type:0});';let g,y;const h="Failed to create Worker. Fallback to execute module in main thread",k=void 0;async function w(){if(!has("esri-workers"))return b(new f);if(!g&&!y)try{const e=p.split("{CONFIGURATION}").join(v());g=URL.createObjectURL(new Blob([e],{type:"text/javascript"}))}catch(r){y=r||{}}let e;if(g)try{e=new Worker(g,{name:"esri-worker-"+P++,...k})}catch(r){d().warn(h,y),e=new f}else d().warn(h,y),e=new f;return b(e)}async function b(e){return new Promise(r=>{function t(s){const a=i(s);a&&a.type===m&&(e.removeEventListener("message",t),e.removeEventListener("error",o),r(e))}function o(r){r.preventDefault(),e.removeEventListener("message",t),e.removeEventListener("error",o),d().warn("Failed to create Worker. Fallback to execute module in main thread",r),(e=new f).addEventListener("message",t),e.addEventListener("error",o)}e.addEventListener("message",t),e.addEventListener("error",o)})}function v(){let s;if(null!=r.default){const e={...r};delete e.default,s=JSON.parse(JSON.stringify(e))}else s=JSON.parse(JSON.stringify(r));s.assetsPath=a(s.assetsPath),s.defaultAssetsPath=s.defaultAssetsPath?a(s.defaultAssetsPath):void 0,s.request.interceptors=[],s.log.interceptors=[],s.locale=t(),s.has={"esri-csp-restrictions":has("esri-csp-restrictions"),"esri-2d-debug":!1,"esri-2d-update-debug":has("esri-2d-update-debug"),"esri-2d-log-updating":has("esri-2d-log-updating"),"featurelayer-pbf":has("featurelayer-pbf"),"featurelayer-fast-triangulation-enabled":has("featurelayer-fast-triangulation-enabled"),"featurelayer-simplify-thresholds":has("featurelayer-simplify-thresholds"),"featurelayer-simplify-payload-size-factors":has("featurelayer-simplify-payload-size-factors"),"featurelayer-simplify-mobile-factor":has("featurelayer-simplify-mobile-factor"),"featurelayer-query-max-depth":has("featurelayer-query-max-depth"),"featurelayer-query-tile-max-features":has("featurelayer-query-tile-max-features"),"featurelayer-query-tile-concurrency":has("featurelayer-query-tile-concurrency"),"featurelayer-query-pausing-enabled":has("featurelayer-query-pausing-enabled"),"featurelayer-snapshot-concurrency":has("featurelayer-snapshot-concurrency"),"featurelayer-snapshot-enabled":has("featurelayer-snapshot-enabled"),"parquetlayer-full-query-feature-count":has("parquetlayer-full-query-feature-count"),"esri-atomics":has("esri-atomics"),"esri-shared-array-buffer":has("esri-shared-array-buffer"),"esri-tiles-debug":has("esri-tiles-debug"),"esri-workers-arraybuffer-transfer":has("esri-workers-arraybuffer-transfer"),"feature-polyline-generalization-factor":has("feature-polyline-generalization-factor"),"host-webworker":1},s.workers.loaderUrl&&(s.workers.loaderUrl=a(s.workers.loaderUrl)),s.workers.workerPath?s.workers.workerPath=a(s.workers.workerPath):s.workers.workerPath=a(e("esri/core/workers/RemoteClient.js")),s.workers.useDynamicImport=has("esri-esbuild-build");const i=r.workers.loaderConfig,l=n({baseUrl:i?.baseUrl,locale:t(),has:{"csp-restrictions":1,"dojo-test-sniff":0,"host-webworker":1,...i?.has},map:{...i?.map},paths:{...i?.paths},packages:i?.packages||[]}),f={buildDate:c,fullVersion:o,revision:u};return JSON.stringify({esriConfig:s,loaderConfig:l,kernelInfo:f})}let P=0;export{w as createWorker};
+import{getAssetUrl as e}from"../../assets.js";import r from"../../config.js";import{getLocale as t}from"../../intl.js";import{fullVersion as o}from"../../kernel.js";import has from"../has.js";import s from"../Logger.js";import{makeAbsolute as a}from"../urlUtils.js";import{loaderConfig as n}from"./loaderConfig.js";import{receiveMessage as i,MessageType as l}from"./utils.js";import f from"./WorkerFallback.js";import{commitHash as u,buildDate as c}from"../../support/revision.js";const d=()=>s.getLogger("esri.core.workers.workerFactory"),{HANDSHAKE:m}=l,p='let globalId=0;const outgoing=new Map,configuration={CONFIGURATION};self.esriConfig=configuration.esriConfig;const workerPath=self.esriConfig.workers.workerPath,HANDSHAKE=0,OPEN=1,OPENED=2,RESPONSE=3,INVOKE=4,ABORT=5;function createAbortError(){const e=new Error("Aborted");return e.name="AbortError",e}function receiveMessage(e){return e&&e.data?"string"==typeof e.data?JSON.parse(e.data):e.data:null}function invokeStaticMessage(e,o,r){const t=r&&r.signal,n=globalId++;let s=null;return new Promise((r,i)=>{if(t){if(t.aborted)return i(createAbortError());s=()=>{outgoing.get(n)&&(outgoing.delete(n),self.postMessage({type:5,jobId:n}),i(createAbortError()))},t.addEventListener("abort",s)}outgoing.set(n,{resolve:r,reject:i}),self.postMessage({type:4,jobId:n,methodName:e,abortable:null!=t,data:o})}).finally(()=>{t&&t.removeEventListener("abort",s)})}let workerRevisionChecked=!1;function checkWorkerRevision(e){if(!workerRevisionChecked&&e.kernelInfo){workerRevisionChecked=!0;const{revision:o,fullVersion:r}=configuration.kernelInfo,{revision:t,fullVersion:n,version:s}=e.kernelInfo;esriConfig.assetsPath!==esriConfig.defaultAssetsPath&&o!==t&&console.warn(`Version mismatch detected between ArcGIS Maps SDK for JavaScript modules and assets. For more information visit https://esriurl.com/using-local-assets.\nModules version: ${r}\nAssets version: ${n??s}\nAssets path: ${esriConfig.assetsPath}`)}}function messageHandler(e){const o=receiveMessage(e);if(!o)return;const r=o.jobId;switch(o.type){case 1:let n;function t(e){const o=n.connect(e);self.postMessage({type:2,jobId:r,data:o},[o])}"function"==typeof define&&define.amd?require([workerPath],e=>{n=e.default||e,checkWorkerRevision(n),n.loadWorker(o.modulePath).then(e=>e||new Promise(e=>{require([o.modulePath],e)})).then(t)}):"System"in self&&"function"==typeof System.import?System.import(workerPath).then(e=>(n=e.default,checkWorkerRevision(n),n.loadWorker(o.modulePath))).then(e=>e||System.import(o.modulePath)).then(t):esriConfig.workers.useDynamicImport?import(workerPath).then(e=>{n=e.default||e,checkWorkerRevision(n),n.loadWorker(o.modulePath).then(e=>e||import(o.modulePath)).then(t)}):(self.RemoteClient||importScripts(workerPath),n=self.RemoteClient.default||self.RemoteClient,checkWorkerRevision(n),n.loadWorker(o.modulePath).then(t));break;case 3:if(outgoing.has(r)){const s=outgoing.get(r);outgoing.delete(r),o.error?s.reject(JSON.parse(o.error)):s.resolve(o.data)}}}self.dojoConfig=configuration.loaderConfig,esriConfig.workers.loaderUrl&&(self.importScripts(esriConfig.workers.loaderUrl),"function"==typeof require&&"function"==typeof require.config&&require.config(configuration.loaderConfig)),self.addEventListener("message",messageHandler),self.postMessage({type:0});';let g,y;const h="Failed to create Worker. Fallback to execute module in main thread";async function k(){if(!has("esri-workers"))return w(new f);if(!g&&!y)try{const e=p.split("{CONFIGURATION}").join(b());g=URL.createObjectURL(new Blob([e],{type:"text/javascript"}))}catch(r){y=r||{}}let e;if(g)try{e=new Worker(g,{name:"esri-worker-"+v++})}catch(r){d().warn(h,y),e=new f}else d().warn(h,y),e=new f;return w(e)}async function w(e){return new Promise(r=>{function t(s){const a=i(s);a&&a.type===m&&(e.removeEventListener("message",t),e.removeEventListener("error",o),r(e))}function o(r){r.preventDefault(),e.removeEventListener("message",t),e.removeEventListener("error",o),d().warn("Failed to create Worker. Fallback to execute module in main thread",r),(e=new f).addEventListener("message",t),e.addEventListener("error",o)}e.addEventListener("message",t),e.addEventListener("error",o)})}function b(){let s;if(null!=r.default){const e={...r};delete e.default,s=JSON.parse(JSON.stringify(e))}else s=JSON.parse(JSON.stringify(r));s.assetsPath=a(s.assetsPath),s.defaultAssetsPath=s.defaultAssetsPath?a(s.defaultAssetsPath):void 0,s.request.interceptors=[],s.log.interceptors=[],s.locale=t(),s.has={"esri-csp-restrictions":has("esri-csp-restrictions"),"esri-2d-debug":!1,"esri-2d-update-debug":has("esri-2d-update-debug"),"esri-2d-log-updating":has("esri-2d-log-updating"),"featurelayer-pbf":has("featurelayer-pbf"),"featurelayer-fast-triangulation-enabled":has("featurelayer-fast-triangulation-enabled"),"featurelayer-simplify-thresholds":has("featurelayer-simplify-thresholds"),"featurelayer-simplify-payload-size-factors":has("featurelayer-simplify-payload-size-factors"),"featurelayer-simplify-mobile-factor":has("featurelayer-simplify-mobile-factor"),"featurelayer-query-max-depth":has("featurelayer-query-max-depth"),"featurelayer-query-tile-max-features":has("featurelayer-query-tile-max-features"),"featurelayer-query-tile-concurrency":has("featurelayer-query-tile-concurrency"),"featurelayer-query-pausing-enabled":has("featurelayer-query-pausing-enabled"),"featurelayer-snapshot-concurrency":has("featurelayer-snapshot-concurrency"),"featurelayer-snapshot-enabled":has("featurelayer-snapshot-enabled"),"parquetlayer-full-query-feature-count":has("parquetlayer-full-query-feature-count"),"esri-atomics":has("esri-atomics"),"esri-shared-array-buffer":has("esri-shared-array-buffer"),"esri-tiles-debug":has("esri-tiles-debug"),"esri-workers-arraybuffer-transfer":has("esri-workers-arraybuffer-transfer"),"feature-polyline-generalization-factor":has("feature-polyline-generalization-factor"),"host-webworker":1},s.workers.loaderUrl&&(s.workers.loaderUrl=a(s.workers.loaderUrl)),s.workers.workerPath?s.workers.workerPath=a(s.workers.workerPath):s.workers.workerPath=a(e("esri/core/workers/RemoteClient.js")),s.workers.useDynamicImport=has("esri-esbuild-build");const i=r.workers.loaderConfig,l=n({baseUrl:i?.baseUrl,locale:t(),has:{"csp-restrictions":1,"dojo-test-sniff":0,"host-webworker":1,...i?.has},map:{...i?.map},paths:{...i?.paths},packages:i?.packages||[]}),f={buildDate:c,fullVersion:o,revision:u};return JSON.stringify({esriConfig:s,loaderConfig:l,kernelInfo:f})}let v=0;export{k as createWorker};

package/core/workers.d.ts

@@ -1,3 +1,29 @@
+/**
+ * This module is a utility framework that simplifies the use of
+ * [Web Workers](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Using_web_workers) in the
+ * ArcGIS Maps SDK for JavaScript.
+ *
+ * The workers framework takes advantage of multi-core CPUs to perform computationally expensive tasks in
+ * a background thread without interfering with the user interface. This framework loads a script
+ * and provides a calling function in the main thread using the [Connection class](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-workers-Connection.html).
+ * The Connection can then be used to offload jobs asynchronously from the main thread to workers.
+ * The workers framework returns a Promise once the job is completed.
+ *
+ * > [!WARNING]
+ * >
+ * > **Known Limitations**
+ * >
+ * > Workers do not have access to document, window and parent objects, and cannot directly affect the parent page; this includes
+ * > DOM manipulation.
+ * >
+ * > The [esriRequest](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html) module can be used within worker script with the following exceptions:
+ * >   - [esriRequest.options.body](https://developers.arcgis.com/javascript/latest/api-reference/esri-request-types.html#RequestOptions) `FormData` value is not supported.
+ * >   - [esriRequest.options.responseType](https://developers.arcgis.com/javascript/latest/api-reference/esri-request-types.html#RequestOptions) supported values are: `array-buffer`, `blob`, `json`, `native`, `text`
+ * >   - [esriRequest.getHeader](https://developers.arcgis.com/javascript/latest/api-reference/esri-request-types.html#GetHeader) is not supported.
+ *
+ * @since 4.2
+ * @see [ES modules custom workers sample](https://github.com/Esri/jsapi-resources/tree/main/core-samples/jsapi-custom-workers)
+ */
 import type Connection from "./workers/Connection.js";
 import type { OpenOptions } from "./workers/workers.js";
 

package/form/elements/inputs.d.ts

@@ -1,3 +1,58 @@
+/**
+ * A convenience module for importing [Input](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-Input.html) classes
+ * when developing with [TypeScript](https://developers.arcgis.com/javascript/latest/get-started/#typescript).
+ * For example, rather than importing form element inputs one at a time like this:
+ *
+ * ```js
+ * import BarcodeScannerInput from "@arcgis/core/form/elements/inputs/BarcodeScannerInput.js";
+ * import ComboBoxInput from "@arcgis/core/form/elements/inputs/ComboBoxInput.js";
+ * import DatePickerInput from "@arcgis/core/form/elements/inputs/DatePickerInput.js";
+ * import DateTimeOffsetPickerInput from "@arcgis/core/form/elements/inputs/DateTimeOffsetPickerInput.js";
+ * import DateTimePickerInput from "@arcgis/core/form/elements/inputs/DateTimePickerInput.js";
+ * import RadioButtonsInput from "@arcgis/core/form/elements/inputs/RadioButtonsInput.js";
+ * import SwitchInput from "@arcgis/core/form/elements/inputs/SwitchInput.js";
+ * import TextAreaInput from "@arcgis/core/form/elements/inputs/TextAreaInput.js";
+ * import TextBoxInput from "@arcgis/core/form/elements/inputs/TextBoxInput.js";
+ * import TimePickerInput from "@arcgis/core/form/elements/inputs/TimePickerInput.js";
+ * ```
+ *
+ * You can use this module to import them on a single line:
+ *
+ * ```js
+ * import { BarcodeScannerInput, ComboBoxInput, DatePickerInput, DateTimeOffsetPickerInput, DateTimePickerInput, RadioButtonsInput, SwitchInput, TextAreaInput, TextBoxInput, TimePickerInput } from "@arcgis/core/form/elements/inputs.js";
+ * ```
+ *
+ * This module also allows you to implement [type guards](https://basarat.gitbook.io/typescript/type-system/typeguard)
+ * on the form element inputs, making your code smarter.
+ *
+ * ```js
+ * import { Input } from "@arcgis/core/form/elements/inputs.js";
+ *
+ * function logFormElementInput(input: Input): void {
+ *   if (input.type === "text-area") {
+ *     console.log("Form element input type is TextAreaInput");
+ *   }
+ *   else {
+ *     // The compiler knows the content element must be an input type such as  `text-area` | `text-box` | `barcode-scanner` | `radio-buttons` | `combo-box`, etc.
+ *     console.log("The value is not a valid form element input.")
+ *   }
+ * }
+ * ```
+ *
+ * @since 4.16
+ * @see [FormTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-FormTemplate.html)
+ * @see [FieldElement](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-FieldElement.html)
+ * @see [BarcodeScannerInput](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-BarcodeScannerInput.html)
+ * @see [ComboBoxInput](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-ComboBoxInput.html)
+ * @see [DatePickerInput](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-DatePickerInput.html)
+ * @see [DateTimeOffsetPickerInput](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-DateTimeOffsetPickerInput.html)
+ * @see [DateTimePickerInput](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-DateTimePickerInput.html)
+ * @see [RadioButtonsInput](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-RadioButtonsInput.html)
+ * @see [SwitchInput](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-SwitchInput.html)
+ * @see [TextAreaInput](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-TextAreaInput.html)
+ * @see [TextBoxInput](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-TextBoxInput.html)
+ * @see [TimePickerInput](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-inputs-TimePickerInput.html)
+ */
 import type BarcodeScannerInputClass from "./inputs/BarcodeScannerInput.js";
 import type ComboBoxInputClass from "./inputs/ComboBoxInput.js";
 import type DatePickerInputClass from "./inputs/DatePickerInput.js";

package/form/elements.d.ts

@@ -1,3 +1,46 @@
+/**
+ * A convenience module for importing [Element](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-Element.html) classes
+ * when developing with [TypeScript](https://developers.arcgis.com/javascript/latest/get-started/#typescript).
+ * For example, rather than importing form elements one at a time like this:
+ *
+ * ```js
+ * import FieldElement from "@arcgis/core/form/elements/FieldElement.js";
+ * import GroupElement from "@arcgis/core/form/elements/GroupElement.js";
+ * import RelationshipElement from "@arcgis/core/form/elements/RelationshipElement.js";
+ * import TextElement from "@arcgis/core/form/elements/TextElement.js";
+ * ```
+ *
+ * You can use this module to import them on a single line:
+ *
+ * ```js
+ * import { FieldElement, GroupElement, RelationshipElement, TextElement } from "@arcgis/core/form/elements.js";
+ * ```
+ *
+ * This module also allows you to implement [type guards](https://basarat.gitbook.io/typescript/type-system/typeguard)
+ * on the form elements, making your code smarter.
+ *
+ * ```js
+ * import { Element } from "@arcgis/core/form/elements.js";
+ *
+ * function logFormElement(element: Element): void {
+ *   if (element.type === "field") {
+ *     console.log("Form element type is field");
+ *   }
+ *   else {
+ *     // The compiler knows the content element must be `field | group | relationship`
+ *     console.log("The value is not a valid form element.")
+ *   }
+ * }
+ * ```
+ *
+ * @since 4.16
+ * @see [FormTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-FormTemplate.html)
+ * @see [FieldElement](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-FieldElement.html)
+ * @see [GroupElement](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-GroupElement.html)
+ * @see [RelationshipElement](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-RelationshipElement.html)
+ * @see [TextElement](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-TextElement.html)
+ * @see [UtilityNetworkAssociationsElement](https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-UtilityNetworkAssociationsElement.html)
+ */
 import type AttachmentElementClass from "./elements/AttachmentElement.js";
 import type FieldElementClass from "./elements/FieldElement.js";
 import type GroupElementClass from "./elements/GroupElement.js";

package/geometry/coordinateFormatter.d.ts

@@ -1,3 +1,36 @@
+/**
+ * Converts between [points](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) and formatted coordinates notation strings
+ * such as:
+ * * decimal degrees
+ * * degrees, minutes, and seconds
+ * * U.S. National Grid (USNG)
+ * * Military Grid Reference System (MGRS).
+ *
+ * To use the conversion methods, the [load()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-coordinateFormatter.html#load) method must be called first
+ * if [isLoaded()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-coordinateFormatter.html#isLoaded) is `false`.
+ *
+ * > [!WARNING]
+ * >
+ * > **Known Limitations**
+ * >
+ * > The browser must support [WebAssembly](https://caniuse.com/#feat=wasm) for this module to work.
+ * > The methods that convert formatted strings to [points](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) expect the spatial reference
+ * > parameter to be a [geographic coordinate system](https://developers.arcgis.com/rest/services-reference/enterprise/using-spatial-references.htm).
+ * > The methods that convert [points](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) to formatted strings expect the point's
+ * > [Point#spatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html#spatialReference) to be a
+ * > [geographic coordinate system](https://developers.arcgis.com/rest/services-reference/enterprise/using-spatial-references.htm).
+ *
+ * @since 4.7
+ * @example
+ * // Assign a latitude/longitude string to a const.
+ * const latlon = "55 56 39.123N 003 09 43.034W";
+ *
+ * // Load dependencies.
+ * await coordinateFormatter.load();
+ *
+ * // Use the `fromLatitudeLongitude` method to convert the latitude/longitude string to a point geometry.
+ * const point = coordinateFormatter.fromLatitudeLongitude(latlon);
+ */
 import type Point from "./Point.js";
 import type SpatialReference from "./SpatialReference.js";
 import type { LatitudeLongitudeFormat } from "./types.js";

package/geometry/geometryEngine.d.ts

@@ -1,3 +1,19 @@
+/**
+ * A client-side geometry engine for testing, measuring, and analyzing the spatial relationship
+ * between two or more 2D geometries. If more than one geometry is required for any of the methods below,
+ * all geometries must have the same spatial reference for the methods to work as expected.
+ *
+ * Read the following blog series to learn more about GeometryEngine:
+ *
+ * - [ArcGIS Blog - GeometryEngine: Testing spatial relationships and editing](https://blogs.esri.com/esri/arcgis/2015/09/09/geometryengine-part-1-testing-spatial-relationships-and-editing/)
+ * - [ArcGIS Blog - GeometryEngine: Measurement](https://blogs.esri.com/esri/arcgis/2015/09/16/geometryengine-part-2-measurement/)
+ * - [ArcGIS Blog - GeometryEngine: Overlay analysis](https://blogs.esri.com/esri/arcgis/2015/09/23/geometryengine-part-3-overlay-analysis/)
+ *
+ * @deprecated since version 4.32. Use [geometry operators](https://developers.arcgis.com/javascript/latest/spatial-analysis/intro-geometry-operators/) instead.
+ * @since 4.0
+ * @see [Sample - Geodesic Buffers (2D & 3D)](https://developers.arcgis.com/javascript/latest/sample-code/ge-geodesicbuffer/)
+ * @see {@link geometry/projection}
+ */
 import type Extent from "./Extent.js";
 import type Point from "./Point.js";
 import type Polygon from "./Polygon.js";

package/geometry/operators/affineTransformOperator.d.ts

@@ -1,3 +1,8 @@
+/**
+ * Applies an affine transformation to 2D geometries via the [Transformation](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-operators-support-Transformation.html) class.
+ *
+ * @since 4.31
+ */
 import type Transformation from "./support/Transformation.js";
 import type { GeometryUnion, GeometrySansMeshUnion } from "../support/typeUtils.js";
 

package/geometry/operators/alphaShapeOperator.d.ts

@@ -1,3 +1,12 @@
+/**
+ * Calculates the alpha shape of 2D points (concave hull).
+ * Alpha shapes are used to generalize bounding polygons containing sets of points or multipoints. Using this operator on other geometry types will produce results, however it is probably not what you are expecting.
+ *
+ * ![Alpha shape operator](https://developers.arcgis.com/javascript/latest/assets/img/apiref/operators/alphaShape.png "Alpha shape operator")
+ *
+ * @since 4.31
+ * @see [Alpha shape - wikipedia](https://en.wikipedia.org/wiki/Alpha_shape)
+ */
 import type Polygon from "../Polygon.js";
 import type { GeometryUnion } from "../support/typeUtils.js";
 

package/geometry/operators/areaOperator.d.ts

@@ -1,3 +1,10 @@
+/**
+ * Returns the planar area of a 2D geometry.
+ *
+ * ![Area operator](https://developers.arcgis.com/javascript/latest/assets/img/apiref/operators/area.png "Area operator")
+ *
+ * @since 4.31
+ */
 import type { AreaUnit } from "../../core/units.js";
 import type { GeometryUnion } from "../support/typeUtils.js";
 

package/geometry/operators/autoCompleteOperator.d.ts

@@ -1,3 +1,8 @@
+/**
+ * Fills the closed gaps between 2D polygons using polygon boundaries and polylines as the boundary for creating new polygons.
+ *
+ * @since 4.31
+ */
 import type Polygon from "../Polygon.js";
 import type Polyline from "../Polyline.js";
 

package/geometry/operators/boundaryOperator.d.ts

@@ -1,3 +1,8 @@
+/**
+ * Calculates the topological boundary of a 2D geometry.
+ *
+ * @since 4.31
+ */
 import type { GeometryUnion, GeometrySansMeshUnion } from "../support/typeUtils.js";
 
 /**

package/geometry/operators/bufferOperator.d.ts

@@ -1,3 +1,14 @@
+/**
+ * Creates planar buffers around 2D geometries. A planar buffer calculates the area around a geometry using the straight line distance between points based on a flat, two-dimensional surface.
+ * This is suitable for rendering smaller areas within a projected coordinate system where the curvature of the Earth can be ignored, such as when all features are contained in one UTM zone.
+ * Planar buffers can introduce distortions and inaccuracies when applied over larger areas.
+ *
+ * ![Buffer operator](https://developers.arcgis.com/javascript/latest/assets/img/apiref/operators/buffer.png "Buffer operator")
+ *
+ * @since 4.31
+ * @see [How Buffer (Analysis) works](https://pro.arcgis.com/en/pro-app/latest/tool-reference/analysis/how-buffer-analysis-works.htm)
+ * @see [Sample - Geometry operator - using a worker for analysis](https://developers.arcgis.com/javascript/latest/sample-code/geometry-operator-worker/)
+ */
 import type Polygon from "../Polygon.js";
 import type { LengthUnit } from "../../core/units.js";
 import type { GeometryUnion } from "../support/typeUtils.js";

package/geometry/operators/centroidOperator.d.ts

@@ -1,3 +1,17 @@
+/**
+ * Calculates the centroid for a 2D geometry. The centroid represents the geometric center of mass,
+ * where the mass is equally distributed at each point/vertex of the geometry.
+ * For example, the centroid of a straight line is the midpoint. The centroid of a point is the point itself.
+ * It is not guaranteed to be within or on the geometry. The centroid of a donut polygon is
+ * the center of the hole, which is outside the polygon. The centroid of a curved polyline is not located on the line itself, but will be some distance away from it.
+ *
+ * ![Centroid operator](https://developers.arcgis.com/javascript/latest/assets/img/apiref/operators/centroid.png "Centroid operator")
+ *
+ * @since 4.31
+ * @see [labelPointOperator](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-operators-labelPointOperator.html)
+ * @see [Sample - Geometry operator - centroid analysis](https://developers.arcgis.com/javascript/latest/sample-code/geometry-operator-centroid/)
+ * @see [Centroid - wikipedia](https://en.wikipedia.org/wiki/Centroid)
+ */
 import type Point from "../Point.js";
 import type { GeometryUnion } from "../support/typeUtils.js";
 

package/geometry/operators/clipOperator.d.ts

@@ -1,3 +1,10 @@
+/**
+ * Clips geometries with a 2D extent.
+ *
+ * ![Clip operator](https://developers.arcgis.com/javascript/latest/assets/img/apiref/operators/clip.png "Clip operator")
+ *
+ * @since 4.31
+ */
 import type Extent from "../Extent.js";
 import type { GeometryUnion, GeometrySansMeshUnion } from "../support/typeUtils.js";
 

package/geometry/operators/containsOperator.d.ts

@@ -1,3 +1,12 @@
+/**
+ * Performs a relational operation to determine if one 2D geometry contains another 2D geometry.
+ * Geometry A contains geometry B, when B is the intersection of A and B.
+ * A contains B is equivalent to B within A. Geometry B can be non-simple geometry.
+ *
+ * ![Contains operator](https://developers.arcgis.com/javascript/latest/assets/img/apiref/operators/contains.png "Contains operator")
+ *
+ * @since 4.31
+ */
 import type { GeometryUnion } from "../support/typeUtils.js";
 
 /**

package/geometry/operators/convexHullOperator.d.ts

@@ -1,3 +1,12 @@
+/**
+ * Calculates the convex hull of 2D geometries.
+ * A convex hull is the smallest convex polygon that encloses a group of geometries or vertices.
+ * The hull is typically a polygon but can also be a polyline or a point in degenerate cases.
+ *
+ * ![Convex hull operator](https://developers.arcgis.com/javascript/latest/assets/img/apiref/operators/convexHull.png "Convex hull operator")
+ *
+ * @since 4.31
+ */
 import type { GeometryUnion, GeometrySansMeshUnion } from "../support/typeUtils.js";
 
 export interface Options {

package/geometry/operators/crossesOperator.d.ts

@@ -1,3 +1,10 @@
+/**
+ * Performs a relational operation to determine if one 2D geometry crosses another 2D geometry.
+ *
+ * ![Crosses operator](https://developers.arcgis.com/javascript/latest/assets/img/apiref/operators/crosses.png "Crosses operator")
+ *
+ * @since 4.31
+ */
 import type { GeometryUnion } from "../support/typeUtils.js";
 
 /**

package/geometry/operators/cutOperator.d.ts

@@ -1,3 +1,21 @@
+/**
+ * Cut 2D geometries with a polyline.
+ *
+ * For polylines, all left cuts will be grouped together in the first
+ * geometry, right cuts and coincident cuts are grouped in the second geometry, and each undefined
+ * cut, along with any uncut parts, are output as separate polylines.
+ *
+ * For polygons, all left cuts are grouped in the first polygon, all right cuts are in the second
+ * polygon, and each undefined cut, along with any left-over parts after cutting, are output as a
+ * separate polygon. If there were no cuts then no geometry will be returned.
+ * If the left or right cut does not exist, the returned geometry will be empty for this type of cut.
+ * An undefined cut will only be produced if a left cut or right cut was produced, and there was a
+ * part left over after cutting or a cut is bounded to the left and right of the polyline that is used to cut.
+ *
+ * ![Cut operator](https://developers.arcgis.com/javascript/latest/assets/img/apiref/operators/cut.png "Cut operator")
+ *
+ * @since 4.31
+ */
 import type Polyline from "../Polyline.js";
 import type { GeometryUnion, GeometrySansMeshUnion } from "../support/typeUtils.js";