@arcgis/core 5.0.0-next.55 → 5.0.0-next.57

package/popup/content.d.ts

@@ -1,3 +1,51 @@
+/**
+ * A convenience module for importing [Content](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-Content.html) classes when developing
+ * with [TypeScript](https://developers.arcgis.com/javascript/latest/get-started/#typescript).
+ * For example, rather than importing content elements one at a time like this:
+ *
+ * ```js
+ * import TextContent from "@arcgis/core/popup/content/TextContent.js";
+ * import MediaContent from "@arcgis/core/popup/content/MediaContent.js";
+ * import FieldsContent from "@arcgis/core/popup/content/FieldsContent.js";
+ * import AttachmentsContent from "@arcgis/core/popup/content/AttachmentsContent.js";
+ * import CustomContent from "@arcgis/core/popup/content/CustomContent.js";
+ * import ExpressionContent from "@arcgis/core/popup/content/ExpressionContent.js";
+ * import RelationshipContent from "@arcgis/core/popup/content/RelationshipContent.js";
+ * ```
+ *
+ * You can use this module to import them on a single line:
+ *
+ * ```js
+ * import { TextContent, MediaContent, FieldsContent, AttachmentsContent, CustomContent, ExpressionContent, RelationshipContent } from "@arcgis/core/popup/content.js";
+ * ```
+ *
+ * This module also allows you to implement [type guards](https://basarat.gitbook.io/typescript/type-system/typeguard)
+ * on the content elements, making your code smarter.
+ *
+ * ```js
+ * import { Content } from "@arcgis/core/popup/content.js";
+ *
+ * function logContentElement(content: Content): void {
+ *   if (content.type === "media") {
+ *     console.log("Content type is media");
+ *   }
+ *   else {
+ *     // The compiler knows the content element must be `text | fields | media | attachment | custom`
+ *     console.log("The value is not a valid popup content element.")
+ *   }
+ * }
+ * ```
+ *
+ * @since 4.11
+ * @see [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html)
+ * @see [TextContent](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-TextContent.html)
+ * @see [MediaContent](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-MediaContent.html)
+ * @see [FieldsContent](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-FieldsContent.html)
+ * @see [AttachmentsContent](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-AttachmentsContent.html)
+ * @see [CustomContent](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-CustomContent.html)
+ * @see [ExpressionContent](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-ExpressionContent.html)
+ * @see [RelationshipContent](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-RelationshipContent.html)
+ */
 import type AttachmentsContentClass from "./content/AttachmentsContent.js";
 import type CustomContentClass from "./content/CustomContent.js";
 import type ExpressionContentClass from "./content/ExpressionContent.js";

package/rasterRenderers.d.ts

@@ -1,3 +1,49 @@
+/**
+ * A convenience module for importing renderer classes that can be used to render
+ * [ImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html) when developing with
+ * [TypeScript](https://developers.arcgis.com/javascript/latest/get-started/#typescript).
+ * For example, rather than importing renderers one at a time like this:
+ *
+ * ```js
+ * import FlowRenderer from "@arcgis/core/renderers/FlowRenderer.js";
+ * import ClassBreaksRenderer from "@arcgis/core/renderers/ClassBreaksRenderer.js";
+ * import UniqueValueRenderer from "@arcgis/core/renderers/UniqueValueRenderer.js";
+ * import RasterStretchRenderer from "@arcgis/core/renderers/RasterStretchRenderer.js";
+ * import RasterColormapRenderer from "@arcgis/core/renderers/RasterColormapRenderer.js";
+ * import RasterShadedReliefRenderer from "@arcgis/core/renderers/RasterShadedReliefRenderer.js";
+ * import VectorFieldRenderer from "@arcgis/core/renderers/VectorFieldRenderer.js";
+ * ```
+ *
+ * You can use this module to import them on a single line:
+ *
+ * ```js
+ * import { FlowRenderer, ClassBreaksRenderer, UniqueValueRenderer, RasterColormapRenderer, RasterStretchRenderer, RasterShadedReliefRenderer, VectorFieldRenderer } from "@arcgis/core/rasterRenderers.js";
+ * ```
+ *
+ * This module also allows you to implement [type guards](https://basarat.gitbook.io/typescript/type-system/typeguard)
+ * on renderers, making your code smarter.
+ *
+ * ```js
+ * import { Renderer } from "@arcgis/core/rasterRenderers.js";
+ *
+ * function logRenderer(renderer: RasterStretchRenderer): void {
+ *  if (renderer.type == "raster-stretch") {
+ *    // the compiler knows the renderer must be a RasterStretchRenderer
+ *    console.log("renderer color ramp: ", renderer.colorRamp);
+ *  }
+ * }
+ * ```
+ *
+ * @deprecated since version 4.32. Use [unionTypes](https://developers.arcgis.com/javascript/latest/api-reference/esri-unionTypes.html) to import union types, or individual modules to import classes.
+ * @since 4.13
+ * @see [FlowRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-FlowRenderer.html)
+ * @see [ClassBreaksRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html)
+ * @see [UniqueValueRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html)
+ * @see [RasterColormapRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterColormapRenderer.html)
+ * @see [RasterStretchRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterStretchRenderer.html)
+ * @see [RasterShadedReliefRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterShadedReliefRenderer.html)
+ * @see [VectorFieldRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-VectorFieldRenderer.html)
+ */
 import type ClassBreaksRendererClass from "./renderers/ClassBreaksRenderer.js";
 import type FlowRendererClass from "./renderers/FlowRenderer.js";
 import type RasterColormapRendererClass from "./renderers/RasterColormapRenderer.js";

package/renderers/support/AuthoringInfo.d.ts

@@ -57,7 +57,7 @@ export default class AuthoringInfo extends JSONSupport {
    * @see [colorRendererCreator.createClassBreaksRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createClassBreaksRenderer)
    * @see [sizeRendererCreator.createClassBreaksRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createClassBreaksRenderer)
    */
-  accessor classificationMethod: AuthoringInfoClassificationMethods | null;
+  accessor classificationMethod: AuthoringInfoClassificationMethods | null | undefined;
   /** Indicates the color ramp was used to create the symbols for Unique Value or Class Breaks renderer for Imagery Layer. */
   get colorRamp(): ColorRamp | null | undefined;
   set colorRamp(value: ColorRampProperties | null | undefined);

package/renderers/support/jsonUtils.d.ts

@@ -1,3 +1,10 @@
+/**
+ * Provides a utility method used to deserialize a JSON renderer object returned by the REST API.
+ *
+ * @since 4.0
+ * @see [Renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html)
+ * @see [Using fromJSON() to create a class instance](https://developers.arcgis.com/javascript/latest/using-fromjson)
+ */
 import type { RendererUnion } from "./typeUtils.js";
 
 /**

package/renderers/support/utils.d.ts

@@ -1,3 +1,8 @@
+/**
+ * Various utilities for accessing renderer colors that match to fields, Arcade expressions, or values.
+ *
+ * @since 4.28
+ */
 import type Color from "../../Color.js";
 import type { RendererUnion } from "./typeUtils.js";
 

package/renderers/visualVariables/SizeVariable.d.ts

@@ -252,7 +252,6 @@ export default class SizeVariable extends VisualVariable {
    * all | Applies the size visual variable to all axes.
    *
    * @default "all"
-   * @see {@link renderers/visualVariables/SizeVariable#RealWorldSize}
    */
   accessor axis: SizeVariableAxis;
   /**
@@ -360,8 +359,6 @@ export default class SizeVariable extends VisualVariable {
    * >
    * >  * This property is not supported for flat (2D) line symbols driven by real world sizes in 3D [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html)s.
    * >  * Data values must refer to the planar size of the feature in the units of the view's spatial reference.
-   *
-   * @see {@link renderers/visualVariables/SizeVariable#RealWorldSize}
    */
   accessor valueUnit: SizeVariableUnit;
   /**

package/renderers/visualVariables/VisualVariable.d.ts

@@ -44,7 +44,7 @@ export default abstract class VisualVariable extends JSONSupport {
    * defined by the [Arcade Visualization Profile](https://developers.arcgis.com/javascript/latest/arcade/#visualization). Expressions
    * in visual variables may reference field values using the `$feature` profile variable and must return a number.
    *
-   * The values returned from this expression are the data used to drive the visualization as defined in the {@link renderers/visualVariables/VisualVariable#stops}.
+   * The values returned from this expression are the data used to drive the visualization as defined in the stops.
    * This takes precedence over [field](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-VisualVariable.html#field).
    * Therefore, this property is typically used as an alternative to [field](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-VisualVariable.html#field) in visual variables.
    *

package/renderers/visualVariables/support/VisualVariableLegendOptions.d.ts

@@ -9,7 +9,7 @@ export default abstract class VisualVariableLegendOptions extends VisualVariable
   /**
    * The title describing the visualization of
    *   the visual variable in the [Legend](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-legend/). This takes precedence over
-   *   a field alias or {@link renderers/visualVariables/support/VisualVariableLegendOptions#valueExpressionTitle}.
+   *   a field alias or [VisualVariable#valueExpressionTitle](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-VisualVariable.html#valueExpressionTitle).
    */
   accessor title: string | null | undefined;
 }

package/renderers.d.ts

@@ -1,3 +1,49 @@
+/**
+ * A convenience module for importing [Renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html) classes when developing with
+ * [TypeScript](https://developers.arcgis.com/javascript/latest/get-started/#typescript).
+ * For example, rather than importing renderers one at a time like this:
+ *
+ * ```js
+ * import ClassBreaksRenderer from "@arcgis/core/renderers/ClassBreaksRenderer.js";
+ * import HeatmapRenderer from "@arcgis/core/renderers/HeatmapRenderer.js";
+ * import SimpleRenderer from "@arcgis/core/renderers/SimpleRenderer.js";
+ * import UniqueValueRenderer from "@arcgis/core/renderers/UniqueValueRenderer.js";
+ * import DictionaryRenderer from "@arcgis/core/renderers/DictionaryRenderer.js";
+ * ```
+ *
+ * You can use this module to import them on a single line:
+ *
+ * ```js
+ * import { ClassBreaksRenderer, HeatmapRenderer, SimpleRenderer, UniqueValueRenderer } from "@arcgis/core/renderers.js";
+ * ```
+ *
+ * This module also allows you to implement [type guards](https://basarat.gitbook.io/typescript/type-system/typeguard)
+ * on renderers, making your code smarter.
+ *
+ * ```js
+ * import { Renderer } from "@arcgis/core/renderers.js";
+ *
+ * function logRenderer(renderer: Renderer): void {
+ *   if (renderer.type === "simple") {
+ *     // new at 4.8, the compiler knows the renderer is a SimpleRenderer
+ *     console.log("renderer symbol: ", renderer.symbol);
+ *   }
+ *   else {
+ *     if (renderer.type !== "heatmap") {
+ *       // the compiler knows the renderer must be a `ClassBreaksRenderer | UniqueValueRenderer`
+ *       console.log("renderer background symbol: ", renderer.backgroundFillSymbol);
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * @deprecated since version 4.32. Use [unionTypes](https://developers.arcgis.com/javascript/latest/api-reference/esri-unionTypes.html) to import union types, or individual modules to import classes.
+ * @since 4.8
+ * @see [ClassBreaksRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html)
+ * @see [HeatmapRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html)
+ * @see [SimpleRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-SimpleRenderer.html)
+ * @see [UniqueValueRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html)
+ */
 import type ClassBreaksRendererClass from "./renderers/ClassBreaksRenderer.js";
 import type DictionaryRendererClass from "./renderers/DictionaryRenderer.js";
 import type DotDensityRendererClass from "./renderers/DotDensityRenderer.js";

package/request.d.ts

@@ -1,3 +1,20 @@
+/**
+ * Retrieves data from a remote server or uploads a file.
+ *
+ * @since 4.0
+ * @see [Sample - Request data from a remote server](https://developers.arcgis.com/javascript/latest/sample-code/request/)
+ * @see [Sample - Search component with custom source](https://developers.arcgis.com/javascript/latest/sample-code/search-component-customsource/)
+ * @example
+ * // request GeoJson data from USGS remote server
+ * let url = "https://earthquake.usgs.gov/earthquakes/feed/v1.0/summary/all_hour.geojson";
+ *
+ * esriRequest(url, {
+ *   responseType: "json"
+ * }).then((response) => {
+ *   // The requested data
+ *   let geoJson = response.data;
+ * });
+ */
 import type { RequestOptions, RequestResponse } from "./request/types.js";
 
 /**

package/rest/closestFacility.d.ts

@@ -1,3 +1,24 @@
+/**
+ * Helps you find closest facilities around any location (incident) on a network.
+ *
+ * When finding closest facilities, you can specify various [parameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html)
+ * including how many to facilities to find and whether the direction of
+ * travel is toward or away from them. Once you've found the closest facilities, you can display
+ * the best route to or from them, return the travel cost for each route, and display directions
+ * to each facility using the [ClosestFacilitySolveResult](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilitySolveResult.html).
+ *
+ * You can also specify a cutoff cost beyond which ArcGIS Network Analyst should not search for a
+ * facility. For instance, you can set up a closest facility problem to search for hospitals
+ * within a 15-minute drive time of the site of an accident. Any hospitals that take longer than
+ * 15 minutes to reach will not be included in the results.
+ *
+ * Parameters must be defined using [ClosestFacilityParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html)
+ * and input to the [solve()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-closestFacility.html#solve) method.
+ *
+ * @since 4.19
+ * @see [ClosestFacilityParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html)
+ * @see [ClosestFacilitySolveResult](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilitySolveResult.html)
+ */
 import type ClosestFacilityParameters from "./support/ClosestFacilityParameters.js";
 import type ClosestFacilitySolveResult from "./support/ClosestFacilitySolveResult.js";
 import type { RequestOptions } from "../request/types.js";

package/rest/featureService/utils.d.ts

@@ -1,3 +1,8 @@
+/**
+ * Provides utility methods for creating [FeatureServices](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html).
+ *
+ * @since 4.28
+ */
 import type FeatureLayer from "../../layers/FeatureLayer.js";
 import type GroupLayer from "../../layers/GroupLayer.js";
 import type SubtypeGroupLayer from "../../layers/SubtypeGroupLayer.js";

package/rest/find.d.ts

@@ -1,3 +1,24 @@
+/**
+ * Search a map service exposed by the ArcGIS Server REST API based on a string value. The search
+ * can be conducted on a single field of a single layer, on many fields of a layer, or on many
+ * fields of many layers.
+ *
+ * Use [FindParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FindParameters.html) to set the parameters of the method.
+ * The result will be an instance of [FindResult](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FindResult.html).
+ *
+ * > [!WARNING]
+ * >
+ * > **Known Limitations**
+ * >
+ * > The find operation is currently not supported if attempting to be used:
+ * > in a 3D [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html)
+ * > with [dynamic layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html#dynamic-layers)
+ *
+ * @since 4.19
+ * @see [FindParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FindParameters.html)
+ * @see [FindResult](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FindResult.html)
+ * @see [Sample - Find](https://developers.arcgis.com/javascript/latest/sample-code/find/)
+ */
 import type FindParameters from "./support/FindParameters.js";
 import type FindResult from "./support/FindResult.js";
 import type { RequestOptions } from "../request/types.js";

package/rest/geometryService.d.ts

@@ -1,3 +1,17 @@
+/**
+ * Represents geometry service resources exposed by the ArcGIS REST API. It is used to
+ * perform various operations on geometries such as project, simplify, buffer, and relationships.
+ *
+ * View the [About the geometry service](https://enterprise.arcgis.com/en/server/latest/publish-services/windows/about-the-geometry-service.htm)
+ * help topic for details. Esri hosts
+ * a geometry service on [sampleserver6.arcgisonline.com](https://sampleserver6.arcgisonline.com/arcgis/rest/services/Utilities/Geometry/GeometryServer)
+ * to support samples. However, we do not guarantee that the service will be available 24/7.
+ *
+ * Many of the functions in geometryService are available for use client-side using geometry operators.
+ * See the [Introduction to geometry operators](https://developers.arcgis.com/javascript/latest/spatial-analysis/intro-geometry-operators/) guide topic for more details.
+ *
+ * @since 4.19
+ */
 import type Point from "../geometry/Point.js";
 import type Polygon from "../geometry/Polygon.js";
 import type Polyline from "../geometry/Polyline.js";

package/rest/geoprocessor.d.ts

@@ -1,3 +1,19 @@
+/**
+ * Represents a GP resource exposed by the ArcGIS REST API. A GP resource represents a
+ * single task in a GP service published using the ArcGIS Server and it supports one of the
+ * following operations dependent on how the service was set up:
+ * * [execute()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-geoprocessor.html#execute) - for when the execution type is synchronous.
+ * * [submitJob()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-geoprocessor.html#submitJob) - for when the execution type is asynchronous.
+ *
+ * If `processExtent` is not set then `execute` and `submitJob` will format web requests compatible
+ * with ArcGIS version prior to 10.6.1.
+ *
+ * @since 4.19
+ * @see [GPMessage](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-GPMessage.html)
+ * @see [ParameterValue](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ParameterValue.html)
+ * @see [JobInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-JobInfo.html)
+ * @see [Sample - Calculate Viewshed](https://developers.arcgis.com/javascript/latest/sample-code/geoprocessing-viewshed/)
+ */
 import type GPOptions from "./geoprocessor/GPOptions.js";
 import type JobInfo from "./support/JobInfo.js";
 import type { RequestOptions } from "../request/types.js";

package/rest/identify.d.ts

@@ -1,3 +1,22 @@
+/**
+ * Performs an identify operation on the layers of a map service exposed by the ArcGIS
+ * Server REST API. Use [IdentifyParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-IdentifyParameters.html) to set the parameters
+ * for the identify operation and [IdentifyResult](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-IdentifyResult.html) to work with
+ * the results.
+ *
+ * > [!WARNING]
+ * >
+ * > **Known Limitations**
+ * >
+ * > The identify operation is currently not supported if attempting to be used
+ * > in a 3D [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html)
+ *
+ * @since 4.19
+ * @see [IdentifyParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-IdentifyParameters.html)
+ * @see [IdentifyResult](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-IdentifyResult.html)
+ * @see [Identify - ArcGIS Server REST API](https://developers.arcgis.com/rest/services-reference/identify-map-service-.htm)
+ * @see [Sample - Identify](https://developers.arcgis.com/javascript/latest/sample-code/identify/)
+ */
 import type IdentifyParameters from "./support/IdentifyParameters.js";
 import type IdentifyResult from "./support/IdentifyResult.js";
 import type { RequestOptions } from "../request/types.js";

package/rest/imageService.d.ts

@@ -1,3 +1,13 @@
+/**
+ * Performs various operations on an image service resource:
+ *
+ * Identify the content of an image service for the input location and mosaic rule.
+ * Compute histograms based on the provided [ImageHistogramParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageHistogramParameters.html).
+ * Compute [statistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-types.html#RasterBandStatistics) and [histograms](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-types.html#RasterHistogram)
+ * for the provided [ImageHistogramParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageHistogramParameters.html).
+ *
+ * @since 4.19
+ */
 import type FindImagesParameters from "./support/FindImagesParameters.js";
 import type FindImagesResult from "./support/FindImagesResult.js";
 import type ImageAngleParameters from "./support/ImageAngleParameters.js";

package/rest/knowledgeGraphService.d.ts

@@ -1,3 +1,42 @@
+/**
+ * A knowledge graph service is associated with several resources. One resource is a [knowledge graph](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-KnowledgeGraph.html),
+ * which contains [entities](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-Entity.html) and [relationships](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-Relationship.html).
+ * Another resource is the [data model](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-DataModel.html) that defines the {@link rest/knowledgeGraph/EntityTypes entity types}
+ * and {@link rest/knowledgeGraph/RelationshipTypes relationship types} in the graph.
+ * A third resource is the [service definition](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-ServiceDefinition.html) which outlines the capabilities of the service.
+ * A knowledge graph service allows users to query both the [knowledge graph](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-KnowledgeGraph.html)
+ * and the [data model](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-DataModel.html). Entities and relationships can be added, updated or deleted from the knowledge graph
+ * using [executeApplyEdits()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html#executeApplyEdits). To visualize knowledge graph data on map, see [knowledge graph layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-KnowledgeGraphLayer.html).
+ *
+ * > [!WARNING]
+ * >
+ * > **Known Limitations**
+ * >
+ * > KnowledgeGraphService capabilities in version 4.26 of the SDK for Javascript are only supported against ArcGIS Enterprise version 11.1 and later.
+ * > KnowledgeGraphService capabilities in version 4.25 of the SDK for Javascript are supported on ArcGIS Enterprise version 11.0 and earlier.
+ *
+ * @since 4.25
+ * @see [Sample - Search a knowledge graph](https://developers.arcgis.com/javascript/latest/sample-code/knowledgegraph-search/)
+ * @see [Sample - Query a knowledge graph](https://developers.arcgis.com/javascript/latest/sample-code/knowledgegraph-query/)
+ * @see [Sample - Edit knowledge graph data](https://developers.arcgis.com/javascript/latest/sample-code/knowledgegraph-applyedits/)
+ * @see [Sample - Work with KnowledgeGraphLayer](https://developers.arcgis.com/javascript/latest/sample-code/knowledgegraph-knowledgegraphlayer/)
+ * @see [KnowledgeGraphLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-KnowledgeGraphLayer.html) for details on visualizing knowledge graph data.
+ * @see [Get started with ArcGIS Knowledge Server](https://enterprise.arcgis.com/en/knowledge/latest/introduction/get-started-with-arcgis-knowledge.htm) for overview of ArcGIS Knowledge for ArcGIS Enterprise
+ * @see [Hosted Knowledge Graph Service](https://developers.arcgis.com/rest/services-reference/enterprise/kgs-hosted-server.htm) for information on managing knowledge graph services via ArcGIS Enterprise and the REST API
+ * @see [Get started with ArcGIS Knowledge (ArcGIS Pro)](https://pro.arcgis.com/en/pro-app/latest/help/data/knowledge/get-started-with-arcgis-knowledge.htm) for information on ArcGIS Knowledge in ArcGIS Pro
+ * @example
+ * const knowledgeGraphModule = await $arcgis.import("@arcgis/core/rest/knowledgeGraphService.js");
+ * let knowledgeGraph;
+ * // define url to knowledge graph service
+ * const url = "https://myHostName.domain.com/server/rest/services/Hosted/myServiceName/KnowledgeGraphServer";
+ * // fetch knowledge graph
+ * KnowledgeGraphModule.fetchKnowledgeGraph(url)
+ *   .then((kg) => {
+ *     // do something with result
+ *     knowledgeGraph = kg;
+ *     console.log(knowledgeGraph);
+ * });
+ */
 import type CodedValueDomain from "../layers/support/CodedValueDomain.js";
 import type RangeDomain from "../layers/support/RangeDomain.js";
 import type EntityType from "./knowledgeGraph/EntityType.js";

package/rest/lastMileDelivery.d.ts

@@ -1,3 +1,15 @@
+/**
+ * Last Mile Delivery is a type of [Vehicle Routing Problem](https://developers.arcgis.com/documentation/mapping-and-location-services/routing-and-directions/vehicle-routing-problem/)
+ * operation that can find the most optimized routes for a fleet of vehicles that need
+ * to make deliveries. It is specifically tailored to the unique challenges of final
+ * deliveries, focusing on efficiency in dense urban environments. It produces
+ * geographically clustered routes so drivers can easily visit each location, which
+ * minimizes the operating cost for the fleet of vehicles.
+ *
+ * @since 4.34
+ * @see [LastMileDeliveryParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-LastMileDeliveryParameters.html)
+ * @see [Solve Last Mile Delivery - ArcGIS Server REST API](https://developers.arcgis.com/rest/routing/last-mile-delivery-service/)
+ */
 import type GPOptions from "./geoprocessor/GPOptions.js";
 import type FeatureSet from "./support/FeatureSet.js";
 import type JobInfo from "./support/JobInfo.js";

package/rest/locator.d.ts

@@ -1,3 +1,27 @@
+/**
+ * A convenience module for importing [locator](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-locator.html) functions when developing with
+ * [TypeScript](https://developers.arcgis.com/javascript/latest/get-started/#typescript).
+ * For example, rather than importing functions one at a time like this:
+ *
+ * ```js
+ * import { addressToLocations } from "@arcgis/core/rest/locator/addressToLocations.js";
+ * import { locationToAddress } from "@arcgis/core/rest/locator/locationToAddress.js";
+ * ```
+ *
+ * You can use this module to import them on a single line:
+ *
+ * ```js
+ * import { addressToLocations, locationToAddress } from "@arcgis/core/rest/locator.js";
+ * ```
+ *
+ * Represents a geocode service resource exposed by the ArcGIS Server REST API. It is used to
+ * generate candidates for an address. It is also used to generate batch results for a set of addresses.
+ *
+ * Set the URL to the ArcGIS Server REST resource that represents a Locator service, for example: `https://geocode.arcgis.com/arcgis/rest/services/World/GeocodeServer`.
+ *
+ * @since 4.19
+ * @see [World Geocoding Service](https://developers.arcgis.com/rest/geocode/api-reference/overview-world-geocoding-service.htm)
+ */
 import type AddressCandidate from "./support/AddressCandidate.js";
 import type SuggestionCandidate from "./support/SuggestionCandidate.js";
 import type { RequestOptions } from "../request/types.js";

package/rest/networkService.d.ts

@@ -1,3 +1,8 @@
+/**
+ * This modules contains functions for working with network services.
+ *
+ * @since 4.20
+ */
 import type NetworkServiceDescription from "./support/NetworkServiceDescription.js";
 import type { RequestOptions } from "../request/types.js";
 

package/rest/networks/queryAssociations.d.ts

@@ -1,3 +1,10 @@
+/**
+ * The utility network associations model connectivity, containment, and structure relations between assets.
+ * This function queries the associations table and return associations for network features in a utility network.
+ *
+ * @since 4.24
+ * @see [Utility Network Associations](https://pro.arcgis.com/en/pro-app/latest/help/data/utility-network/associations.htm)
+ */
 import type QueryAssociationsParameters from "./support/QueryAssociationsParameters.js";
 import type QueryAssociationsResult from "./support/QueryAssociationsResult.js";
 import type { RequestOptions } from "../../request/types.js";

package/rest/networks/support/NetworkElement.d.ts

@@ -15,7 +15,7 @@ export interface NetworkElementProperties extends JSONSupportMixinProperties, Pa
  *
  * X1       X2
  * ```
- * It is worth mentioning that elements in the network topology also have an elementId which is purely internal to the network and not exposed externally. Those elementIds are then converted to matching {@link rest/networks/support/NetworkElement#objectID}/[globalId](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-NetworkElement.html#globalId)`.
+ * It is worth mentioning that elements in the network topology also have an elementId which is purely internal to the network and not exposed externally. Those elementIds are then converted to matching [objectId](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-NetworkElement.html#objectId)/[globalId](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-support-NetworkElement.html#globalId)`.
  *
  * @since 4.20
  * @see [trace](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-networks-trace.html)

package/rest/networks/synthesizeAssociationGeometries.d.ts

@@ -1,3 +1,10 @@
+/**
+ * The utility network associations model connectivity, containment, and structure relations between assets.
+ * Associations do not have a spatial presence, so this function synthesizes the associations by providing an extent, and returning all associations within the extent.
+ *
+ * @since 4.20
+ * @see [Utility Network Associations](https://pro.arcgis.com/en/pro-app/latest/help/data/utility-network/associations.htm)
+ */
 import type AssociationGeometriesResult from "./support/AssociationGeometriesResult.js";
 import type SynthesizeAssociationGeometriesParameters from "./support/SynthesizeAssociationGeometriesParameters.js";
 import type { RequestOptions } from "../../request/types.js";

package/rest/networks/trace.d.ts

@@ -1,3 +1,9 @@
+/**
+ * Trace is the core analytic of the utility network, by providing a set of parameters, you can start the trace in one or more features and traverse the network topology satisfying the parameters until the trace stops at end points or when the definition of the trace condition barriers are met. The trace returns a collection of elements and their source, function results, diagram or aggregated geometries.
+ *
+ * @since 4.20
+ * @see [Learn more about tracing](https://pro.arcgis.com/en/pro-app/2.7/help/data/utility-network/about-tracing-utility-networks.htm)
+ */
 import type TraceParameters from "./support/TraceParameters.js";
 import type TraceResult from "./support/TraceResult.js";
 import type { RequestOptions } from "../../request/types.js";

package/rest/places.d.ts

@@ -1,3 +1,37 @@
+/**
+ * > [!WARNING]
+ * >
+ * > **Note:** Effective February 20, 2025, Esri made changes to our global places data. As a result, the Places service will have new category IDs. Old category IDs will remain functional until March 22, 2025. We encourage you to transition to the new category IDs as soon as possible. For more information, see the [Places category finder](https://developers.arcgis.com/documentation/mapping-and-location-services/place-finding/places-category-finder/).
+ *
+ * Find [places](https://developers.arcgis.com/documentation/mapping-apis-and-services/places/) within a search distance of a geographic point or within an extent,
+ * or find more information about specific places.
+ * Places, also known as points of interest (POIs), are businesses and geographic locations that one can discover around the world.
+ * Places also contain attributes such as name, category, street address, contact information, and more.
+ *
+ * With the [places service](https://developers.arcgis.com/rest/places/) one can build powerful applications to help people discover, locate, and learn more about places
+ * around them. The places service can search for businesses, points of interest (POI), and popular geographic features near a
+ * location or within a bounding box. This service is currently only available if you have an
+ * [ArcGIS Location Platform account](https://location.arcgis.com/).
+ *
+ * To start, one should identify one or more place categories
+ * for the types of places of interest. Categories are used to help filter search results so only the places of interest
+ * are returned. All categories have a name and a unique ID. To help find the appropriate category and ID, one can use the [places category finder](https://developers.arcgis.com/documentation/mapping-apis-and-services/places/places-category-finder/) tool.
+ *
+ * Once categories have been chosen, use the [queryPlacesNearPoint()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-places.html#queryPlacesNearPoint) or
+ * [queryPlacesWithinExtent()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-places.html#queryPlacesWithinExtent) method. To filter and return the best results, provide a list of categories
+ * and/or keywords when you search. When places are returned, they contain attributes such as name, placeId, location, and categories.
+ *
+ * @since 4.27
+ * @see [Sample -  Find nearby places and details](https://developers.arcgis.com/javascript/latest/sample-code/places/)
+ * @see [Introduction to places](https://developers.arcgis.com/documentation/mapping-apis-and-services/places/)
+ * @see [Places category finder](https://developers.arcgis.com/documentation/mapping-apis-and-services/places/places-category-finder/)
+ * @see [Places service](https://developers.arcgis.com/rest/places/)
+ * @see [FetchPlaceParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FetchPlaceParameters.html)
+ * @see [PlacesParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PlacesParameters.html)
+ * @see [PlacesQueryParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PlacesQueryParameters.html)
+ * @see [PlaceResult](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PlaceResult.html)
+ * @see [PlacesQueryResult](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PlacesQueryResult.html)
+ */
 import type FetchPlaceParameters from "./support/FetchPlaceParameters.js";
 import type PlacesQueryParameters from "./support/PlacesQueryParameters.js";
 import type PlacesQueryResult from "./support/PlacesQueryResult.js";