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

package/rest/geometryService/types.d.ts

@@ -2,50 +2,71 @@ import type Polygon from "../../geometry/Polygon.js";
 import type Polyline from "../../geometry/Polyline.js";
 import type SpatialReference from "../../geometry/SpatialReference.js";
 
+/** @since 5.0 */
 export interface CutResult<T extends Polygon | Polyline> {
+  /** @since 5.0 */
   cutIndexes: number[];
+  /** @since 5.0 */
   geometries: T[];
 }
 
+/** @since 5.0 */
 export type ConversionType = "mgrs" | "usng" | "utm" | "geo-ref" | "gars" | "dms" | "ddm" | "dd";
 
+/** @since 5.0 */
 export interface FromGeoCoordinateStringParameters {
   /**
    * Conversion options for mgrs and utm conversion types. See
    * the [ArcGIS REST API documentation](https://developers.arcgis.com/rest/services-reference/to-geocoordinatestring.htm)
    * for valid conversion modes and their descriptions.
+   *
+   * @since 5.0
    */
   conversionMode?: string;
   /**
    * The conversion type of the input strings.
    *
    * @default mrgs
+   * @since 5.0
    */
   conversionType?: ConversionType;
   /**
    * The spatial reference (or WKID of the spatial reference)
    * of the XY-coordinates to be converted.
+   *
+   * @since 5.0
    */
   sr?: SpatialReference | string | number;
   /**
    * An array of formatted strings as specified by `conversionType`.
    * Example: `["01N AA 66021 00000" , "11S NT 00000 62155" , "31U BT 94071 65288"]`
+   *
+   * @since 5.0
    */
   strings: string[];
 }
 
+/** @since 5.0 */
 export interface ToGeoCoordinateStringParameters extends Omit<FromGeoCoordinateStringParameters, "strings"> {
   /**
    * If `true`, then spaces are added between components of the string. The
    * `addSpaces` parameter applies only to conversion types `mgrs`, `usng` and `utm`. The default value for `mgrs` is `false`
    * , while the default value for both `usng` and `utm` is `true`.
+   *
+   * @since 5.0
    */
   addSpaces?: boolean;
-  /** An array of XY-coordinates (in JSON format) to be converted. */
+  /**
+   * An array of XY-coordinates (in JSON format) to be converted.
+   *
+   * @since 5.0
+   */
   coordinates: number[][];
   /**
    * The number of digits to output for each of the numerical portions in the string.
    * The default value depends of `conversionType`. See the [ArcGIS REST API documentation](https://developers.arcgis.com/rest/services-reference/from-geocoordinatestring.htm) for default values.
+   *
+   * @since 5.0
    */
   numOfDigits?: number;
   /**
@@ -54,6 +75,7 @@ export interface ToGeoCoordinateStringParameters extends Omit<FromGeoCoordinateS
    * only to conversion types `mgrs`, `usng` and `geo-ref`.
    *
    * @default true
+   * @since 5.0
    */
   rounding?: boolean;
 }

package/rest/geoprocessor/GPOptions.d.ts

@@ -23,11 +23,11 @@ export default abstract class GPOptions extends Accessor {
   set processExtent(value: ExtentProperties | null | undefined);
   /**
    * The spatial reference that the model will use to perform geometry operations.
-   * If `processSpatialReference` is specified and {@link rest/geoprocessor/GPOptions#outputSpatialReference}
+   * If `processSpatialReference` is specified and [outSpatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-geoprocessor-GPOptions.html#outSpatialReference)
    * is not specified, the output geometries will be in the spatial reference of the process
    * spatial reference.
    *
-   * A possible common scenario for using `processSpatialReference` and `outputSpatialReference` is
+   * A possible common scenario for using `processSpatialReference` and `outSpatialReference` is
    * that you would like to perform spatial operations like buffer or clip on a projected coordinate
    * system such as web mercator. And you would like to recieve the output based on a geographic
    * coordinates such as WGS84.
@@ -37,7 +37,7 @@ export default abstract class GPOptions extends Accessor {
   /**
    * When `true`, individual values in a value table will be prefixed with the associated column name.
    * If false, the default, a value table will consist as a two dimensional array of values.
-   * This property is referenced by {@link rest/geoprocessor/execute} and [JobInfo#fetchResultData()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-JobInfo.html#fetchResultData).
+   * This property is referenced by [execute](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-geoprocessor-execute.html) and [JobInfo#fetchResultData()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-JobInfo.html#fetchResultData).
    *
    * @default false
    * @since 4.29
@@ -46,7 +46,7 @@ export default abstract class GPOptions extends Accessor {
   accessor returnColumnName: boolean;
   /**
    * When `true`, a parameter value of type `"feature-record-set-layer"` will be returned as a [feature layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html)
-   * rather than a [feature set](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html). This property is referenced by {@link rest/geoprocessor/execute}
+   * rather than a [feature set](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html). This property is referenced by [execute](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-geoprocessor-execute.html)
    * and [JobInfo#fetchResultData()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-JobInfo.html#fetchResultData). The default is false.
    *
    * @default false
@@ -56,7 +56,7 @@ export default abstract class GPOptions extends Accessor {
    */
   accessor returnFeatureCollection: boolean;
   /**
-   * Returns geometry with measures when [LastMileDeliveryParameters#routeShape](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-LastMileDeliveryParameters.html#routeShape)/{@link rest/geoprocessor/GPOptions#routeShape} is `shape-with-measures`. If `true`, m-values will be included in the results if the features have m-values; otherwise, m-values are not returned. The default is false.
+   * Returns geometry with measures when [LastMileDeliveryParameters#routeShape](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-LastMileDeliveryParameters.html#routeShape) is `shape-with-measures`. If `true`, m-values will be included in the results if the features have m-values; otherwise, m-values are not returned. The default is false.
    *
    * @default false
    */

package/rest/geoprocessor/execute.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Sends a request to the server to execute a synchronous GP task.
+ *
+ * @since 4.19
+ */
+

package/rest/imageService.d.ts

@@ -3,7 +3,7 @@
  *
  * 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)
+ * Compute [statistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-raster-types.html#RasterBandStatistics) and [histograms](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-raster-types.html#RasterHistogram)
  * for the provided [ImageHistogramParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageHistogramParameters.html).
  *
  * @since 4.19
@@ -40,7 +40,7 @@ import type MeasureAreaFromImageResult from "./support/MeasureAreaFromImageResul
 import type MeasureFromImageParameters from "./support/MeasureFromImageParameters.js";
 import type MeasureLengthFromImageResult from "./support/MeasureLengthFromImageResult.js";
 import type { GeometryUnion } from "../geometry/types.js";
-import type { RasterBandStatistics, RasterHistogram } from "../layers/support/types.js";
+import type { RasterBandStatistics, RasterHistogram } from "../layers/raster/types.js";
 import type { RequestOptions } from "../request/types.js";
 
 export interface ImageServiceHistogramsResult {
@@ -84,7 +84,7 @@ export function computeAngles(url: string, parameters: ImageAngleParameters, req
 export function computePixelSpaceLocations(url: string, parameters: ImagePixelLocationParameters, requestOptions?: RequestOptions): Promise<ImagePixelLocationResult>;
 
 /**
- * Computes [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)
+ * Computes [statistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-raster-types.html#RasterBandStatistics) and [histograms](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-raster-types.html#RasterHistogram)
  * for the provided [ImageHistogramParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageHistogramParameters.html).
  * If a [raster function](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageHistogramParameters.html#rasterFunction) and a
  * [mosaic rule](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ImageHistogramParameters.html#mosaicRule) are not specified, the current settings on the layer will be used.
@@ -99,8 +99,8 @@ export function computePixelSpaceLocations(url: string, parameters: ImagePixelLo
  *
  * Property | Type | Description
  * ---------|------|-------------
- * histograms[] | [RasterHistogram](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-types.html#RasterHistogram) | Result containing raster histograms.
- * bandStatistics[] | [RasterBandStatistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-types.html#RasterBandStatistics) | Raster band statistics.
+ * histograms[] | [RasterHistogram](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-raster-types.html#RasterHistogram) | Result containing raster histograms.
+ * bandStatistics[] | [RasterBandStatistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-raster-types.html#RasterBandStatistics) | Raster band statistics.
  */
 export function computeStatisticsHistograms(url: string, parameters: ImageHistogramParameters, requestOptions?: RequestOptions): Promise<ImageServiceStatisticsHistogramsResult>;
 

package/rest/knowledgeGraph/DataModel.d.ts

@@ -16,7 +16,7 @@ export interface DataModelProperties extends JSONSupportMixinProperties {
 /**
  * The data model defines the [entity types](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-EntityType.html)
  * and [relationship types](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-RelationshipType.html) in a
- * {@link rest/knowledgeGraph/KnowledgeGraphService knowledge graph service}  as well as some additional settings.
+ * [knowledge graph service](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html) as well as some additional settings.
  * The DataModel resource allows users to query the properties of both entity and relationship types.
  * By defining these types and their properties, the data model defines the schema of the graph.
  *
@@ -257,7 +257,7 @@ export default abstract class DataModel extends JSONSupport {
   get provenanceSourceTypeValues(): SourceTypeValueBehavior[];
   /** A list of the [relationship types](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-RelationshipType.html) in the knowledge graph including their associated properties. */
   get relationshipTypes(): RelationshipType[];
-  /** List of the {@link rest/knowledgeGraph/SearchIndexes search indexes} in the knowledge graph. */
+  /** List of the [search indexes](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-SearchIndex.html) in the knowledge graph. */
   get searchIndexes(): SearchIndex[];
   /** Specifies [spatial reference](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html) information for the knowledge graph. */
   get spatialReference(): SpatialReference | null | undefined;

package/rest/knowledgeGraph/GraphAnyValue.d.ts

@@ -2,4 +2,5 @@ import type GraphObject from "./GraphObject.js";
 import type Path from "./Path.js";
 import type { GeometryUnion } from "../../geometry/types.js";
 
+/** @since 5.0 */
 export type GraphAnyValue = Path | GraphObject | GeometryUnion | Date | string | number | GraphAnyValue[] | null | undefined;

package/rest/knowledgeGraph/GraphDataModelSingletonOperationResult.d.ts

@@ -2,13 +2,23 @@ import type Accessor from "../../core/Accessor.js";
 import type EsriError from "../../core/Error.js";
 import type KnowledgeGraph from "./KnowledgeGraph.js";
 
+/** @since 5.0 */
 export interface GraphDataModelSingletonOperationResultProperties extends Partial<Pick<GraphDataModelSingletonOperationResult, "decoderError" | "updatedKnowledgeGraph">> {}
 
 /** @since 5.0 */
 export default class GraphDataModelSingletonOperationResult extends Accessor {
+  /** @since 5.0 */
   constructor(properties?: GraphDataModelSingletonOperationResultProperties);
-  /** Any errors encountered while decoding the results. */
+  /**
+   * Any errors encountered while decoding the results.
+   *
+   * @since 5.0
+   */
   accessor decoderError: EsriError | null;
-  /** The updated knowledge graph with the applied additions, updates, and deletions. */
+  /**
+   * The updated knowledge graph with the applied additions, updates, and deletions.
+   *
+   * @since 5.0
+   */
   accessor updatedKnowledgeGraph: KnowledgeGraph | null;
 }

package/rest/knowledgeGraph/GraphDeleteNamedTypeResult.d.ts

@@ -4,7 +4,7 @@ import type { GraphDataModelOperationResultProperties } from "./GraphDataModelOp
 export interface GraphDeleteNamedTypeResultProperties extends GraphDataModelOperationResultProperties {}
 
 /**
- * The result returned when {@link rest/knowledgeGraphService#executeDeleteNamedTypes deleting} an [entity type](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-EntityType.html) or
+ * The result returned when [deleting](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html#executeDeleteNamedType) an [entity type](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-EntityType.html) or
  * [relationship type](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-RelationshipType.html) from a knowledge graph.
  * This contains the updated [knowledge graph](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-KnowledgeGraph.html) and any errors encountered.
  *

package/rest/knowledgeGraph/GraphDeletePropertyResult.d.ts

@@ -4,7 +4,7 @@ import type { GraphDataModelOperationResultProperties } from "./GraphDataModelOp
 export interface GraphDeletePropertyResultProperties extends GraphDataModelOperationResultProperties {}
 
 /**
- * Result of {@link rest/knowledgeGraphService#executeDeleteGraphProperties deleting graph properties} from an entity type or relationship type in a knowledge graph data model.
+ * Result of [deleting graph properties](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html#executeDeleteGraphProperty) from an entity type or relationship type in a knowledge graph data model.
  *
  * @since 4.33
  */

package/rest/knowledgeGraph/GraphQuery.d.ts

@@ -5,7 +5,7 @@ export interface GraphQueryProperties extends Partial<Pick<GraphQuery, "openCyph
 /**
  * Defines the query operation performed on a knowledge graph service's
  * [graph](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-KnowledgeGraph.html) resource.
- * The {@link rest/knowledgeGraph/Entities} and {@link rest/knowledgeGraph/Relationships}
+ * The [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)
  * in the graph are queried by sending an Esri implementation of [openCypher](https://opencypher.org/) query.
  *
  * > [!WARNING]

package/rest/knowledgeGraph/GraphSearch.d.ts

@@ -5,10 +5,10 @@ export interface GraphSearchProperties extends Partial<Pick<GraphSearch, "search
 /**
  * The search operation is performed on a [knowledge graph service's](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html)
  * [graph](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-KnowledgeGraph.html) resource.
- * This operation allows you to search the properties of both {@link rest/knowledgeGraph/Entities} and
- * {@link rest/knowledgeGraph/Relationships} in the graph.
+ * This operation allows you to search the properties of both [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) in the graph.
  * Any field with the Text data type or the [Globally Unique Identifier (GUID)](https://pro.arcgis.com/en/pro-app/latest/help/data/geodatabases/overview/arcgis-field-data-types.htm#GUID-97064FAE-B42E-4DC3-A5C9-9A6F12D053A8) data type with the
- * {@link rest/knowledgeGraph/GraphProperty#searchable} properties set to `true` is included in the search.
+ * Any field defined by [GraphProperty](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphProperty.html) with the `searchable` property set to `true` is included in the search.
  * A search index is built and maintained automatically on the values for all searchable fields.
  *
  * @since 4.25

package/rest/knowledgeGraph/GraphSearchStreaming.d.ts

@@ -6,10 +6,10 @@ export interface GraphSearchStreamingProperties extends GraphSearchProperties, P
 /**
  * The search operation is performed on a knowledge graph service's
  * [graph](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-KnowledgeGraph.html) resource.
- * This operation allows you to search the properties of both {@link rest/knowledgeGraph/Entities} and
- * {@link rest/knowledgeGraph/Relationships} in the graph.
+ * This operation allows you to search the properties of both [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) in the graph.
  * Any field with the `text` data type or the [Globally Unique Identifier (GUID)](https://pro.arcgis.com/en/pro-app/latest/help/data/geodatabases/overview/arcgis-field-data-types.htm#GUID-97064FAE-B42E-4DC3-A5C9-9A6F12D053A8) data type with the
- * {@link rest/knowledgeGraph/GraphProperty#searchable} properties set to `true` is included in the search.
+ * Any field defined by [GraphProperty](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphProperty.html) with the `searchable` property set to `true` is included in the search.
  * A search index is built and maintained automatically on the values for all searchable fields.
  *
  * Streaming search returns the [result](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphQueryStreamingResult.html) faster than search and in small chunks that can be rendered immediately.

package/rest/knowledgeGraph/SearchIndex.d.ts

@@ -55,7 +55,7 @@ export default class SearchIndex extends Accessor {
   get analyzers(): SearchIndexAnalyzer[];
   /** The name of the search index. */
   get name(): string;
-  /** A map of the {@link rest/knowledgeGraph/GraphNamedTyp named types} and their properties that are included in the search index. */
+  /** A map of the [named types](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphNamedObject.html) and their properties that are included in the search index. */
   get searchProperties(): Map<string, SearchProperties>;
   /**
    * Specifies if the index supports searching provenance, entities, relationships or both.

package/rest/knowledgeGraph/toolService/findPaths/CIMFilteredFindPathsPathFilter.d.ts

@@ -3,9 +3,9 @@ import type { JSONSupport, JSONSupportMixinProperties } from "../../../../core/J
 export interface CIMFilteredFindPathsPathFilterProperties extends JSONSupportMixinProperties, Partial<Pick<CIMFilteredFindPathsPathFilter, "filterType" | "iD" | "itemType" | "itemTypeName" | "propertyFilterPredicate">> {}
 
 /**
- * Defines  {@link rest/knowledgGraph/toolSettings/findPaths/CIMFilteredFindPathsConfiguration#pathFilters path filters}  to determine what records are used to find paths in the graph between the
- * {@link rest/knowledgGraph/toolSettings/findPaths/CIMFilteredFindPathsConfiguration#originEntities origin}
- *  and {@link rest/knowledgGraph/toolSettings/findPaths/CIMFilteredFindPathsConfiguration#destinationEntities destination} entities.
+ * Defines  [path filters](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsConfiguration.html#pathFilters)  to determine what records are used to find paths in the graph between the
+ * [origin](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsConfiguration.html#originEntities)
+ *  and [destination](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsConfiguration.html#destinationEntities) entities.
  * A path filter can be used for a specific record, in this case the [iD](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsPathFilter.html#iD) is used, or for all records of an entity or relationship
  * type, in which case the  [iD](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsPathFilter.html#iD) is null.
  *

package/rest/knowledgeGraph/toolService/findPaths/CIMFilteredFindPathsResultJSON.d.ts

@@ -1,28 +1,66 @@
 
-/** The returned result of [executeFindPaths()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html#executeFindPaths) and [executeFindPathsAsynchronous()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html#executeFindPathsAsynchronous). */
+/**
+ * The returned result of [executeFindPaths()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html#executeFindPaths) and [executeFindPathsAsynchronous()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html#executeFindPathsAsynchronous).
+ *
+ * @since 5.0
+ */
 export default interface CIMFilteredFindPathsResultJSON {
-  /** Warnings indicating why a path was not found. */
+  /**
+   * Warnings indicating why a path was not found.
+   *
+   * @since 5.0
+   */
   configurationWarning: "None" | "AllOriginsAreExcluded" | "AllDestinationsAreExcluded" | "AllOptionalWaypointsAreExcluded" | "AtLeastOneMandatoryEntityWaypointIsExcluded" | "AtLeastOneMandatoryRelationshipWaypointIsExcluded" | "ReachedMaxPathLength";
-  /** Any errors encountered while executing filtered find path. */
+  /**
+   * Any errors encountered while executing filtered find path.
+   *
+   * @since 5.0
+   */
   error?: CIMFilteredFindPathsError;
-  /** The paths returned. */
+  /**
+   * The paths returned.
+   *
+   * @since 5.0
+   */
   paths: CIMFilteredFindPathsResultPaths;
-  /** Pathfinding statistics. */
+  /**
+   * Pathfinding statistics.
+   *
+   * @since 5.0
+   */
   statistics: CIMFilteredFindPathsStatistics;
-  /** The returned type of `executeFindPaths` and `executeFindPathsAsynchronous`. */
+  /**
+   * The returned type of `executeFindPaths` and `executeFindPathsAsynchronous`.
+   *
+   * @since 5.0
+   */
   type: "CIMFilteredFindPathsResult";
 }
 
 /**
  * Errors returned in the result of [executeFindPaths()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html#executeFindPaths) and [executeFindPathsAsynchronous()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraphService.html#executeFindPathsAsynchronous).
  * When no path has been found, and `CIMFilteredFindPathsResultJSON.configurationWarning` is different from `None`, it is likely that the user made an unintended mistake in the configuration
+ *
+ * @since 5.0
  */
 export interface CIMFilteredFindPathsError {
-  /** Details about the error. */
+  /**
+   * Details about the error.
+   *
+   * @since 5.0
+   */
   detailedErrorMessage: string;
-  /** Errors indicating why the tool could not be executed. */
+  /**
+   * Errors indicating why the tool could not be executed.
+   *
+   * @since 5.0
+   */
   error: "None" | "ConfigurationHasTooManyInputEntities" | "ConfigurationIsTooComplex" | "PunctualEventHasNoTime" | "DurativeEventHasNoTime" | "DurativeEventHasOneMissingTime" | "DurativeEventHasSwappedTimes";
-  /** "CIMFilteredFindPathsError" */
+  /**
+   * "CIMFilteredFindPathsError"
+   *
+   * @since 5.0
+   */
   type: "CIMFilteredFindPathsError";
 }
 
@@ -39,19 +77,45 @@ export interface CIMFilteredFindPathsError {
  * to ensure that the pathfinding results are accurate.
  * For example, to guarantee that all paths of length up to 'L' between 'A' and 'B' are present in the local graph,
  * we ensure that the sum of counts of "expansion" queries related to 'A' and 'B' is greater or equal to 'L'.
+ *
+ * @since 5.0
  */
 export interface CIMFilteredFindPathsStatistics {
-  /** Gets or sets the count of expansion queries that were done to discover the neighborhood of some destination entities. */
+  /**
+   * Gets or sets the count of expansion queries that were done to discover the neighborhood of some destination entities.
+   *
+   * @since 5.0
+   */
   countDestinationExpansionQueries?: number;
-  /** Number of edges in the local graph. One edge in the local graph may represent multiple relationships when these relationships are parallel and equivalent with regard to pathfinding */
+  /**
+   * Number of edges in the local graph. One edge in the local graph may represent multiple relationships when these relationships are parallel and equivalent with regard to pathfinding
+   *
+   * @since 5.0
+   */
   countLocalGraphEdges?: number;
-  /** Number of nodes found in the local graph. */
+  /**
+   * Number of nodes found in the local graph.
+   *
+   * @since 5.0
+   */
   countLocalGraphNodes?: number;
-  /** Gets or sets the count of expansion queries that were done to discover the neighborhood of some origin entities. */
+  /**
+   * Gets or sets the count of expansion queries that were done to discover the neighborhood of some origin entities.
+   *
+   * @since 5.0
+   */
   countOriginExpansionQueries?: number;
-  /** Gets or sets the count of expansion queries that were done to discover the neighborhood of entity or relationship waypoints. */
+  /**
+   * Gets or sets the count of expansion queries that were done to discover the neighborhood of entity or relationship waypoints.
+   *
+   * @since 5.0
+   */
   countWaypointsExpansionQueries?: number;
-  /** "CIMFilteredFindPathsStatistics" */
+  /**
+   * "CIMFilteredFindPathsStatistics"
+   *
+   * @since 5.0
+   */
   type: "CIMFilteredFindPathsStatistics";
 }
 
@@ -85,34 +149,92 @@ export interface CIMFilteredFindPathsStatistics {
  *
  *  Note that origin and destination of a relationship may not match origin and destination of the relationship group
  *  because the relationship can be traversed backwards.
+ *
+ * @since 5.0
  */
 export interface CIMFilteredFindPathsResultPaths {
-  /** The list of entities that may be used in paths (not all entities are guaranteed to be used). */
+  /**
+   * The list of entities that may be used in paths (not all entities are guaranteed to be used).
+   *
+   * @since 5.0
+   */
   entitiesUIDs?: string[];
-  /** A list parallel to EntitiesUIDs representing entity type indices. If EntityTypes[i] >= 0, EntitiesUIDs[i] has type IndexedEntityTypes[EntityTypes[i]], otherwise the entity has been deleted after the find path operation. */
+  /**
+   * A list parallel to EntitiesUIDs representing entity type indices. If EntityTypes[i] >= 0, EntitiesUIDs[i] has type IndexedEntityTypes[EntityTypes[i]], otherwise the entity has been deleted after the find path operation.
+   *
+   * @since 5.0
+   */
   entityTypes?: number[];
-  /** The list of entity types, indexed by `entityTypes` */
+  /**
+   * The list of entity types, indexed by `entityTypes`
+   *
+   * @since 5.0
+   */
   indexedEntityTypes?: string[];
-  /** The list of relationship types, indexed by `relationshipTypes` */
+  /**
+   * The list of relationship types, indexed by `relationshipTypes`
+   *
+   * @since 5.0
+   */
   indexedRelationshipTypes?: string[];
-  /** List of relationships groups indices used by paths. Values must be positive. */
+  /**
+   * List of relationships groups indices used by paths. Values must be positive.
+   *
+   * @since 5.0
+   */
   pathsBuffer?: number[];
-  /** List of paths relationships groups end indices (indexes into 'PathsBuffer'). Values must be positive. */
+  /**
+   * List of paths relationships groups end indices (indexes into 'PathsBuffer'). Values must be positive.
+   *
+   * @since 5.0
+   */
   pathsEndIndex?: number[];
-  /** The list of relationship's origin entity index (indexes into `entitiesUIDs`). */
+  /**
+   * The list of relationship's origin entity index (indexes into `entitiesUIDs`).
+   *
+   * @since 5.0
+   */
   relationshipsFrom?: number[];
-  /** The list of relationship group's origin entity index (indexes into `entitiesUIDs`). Values must be positive. */
+  /**
+   * The list of relationship group's origin entity index (indexes into `entitiesUIDs`). Values must be positive.
+   *
+   * @since 5.0
+   */
   relationshipsGroupsFrom?: number[];
-  /** The list of relationship group's destination entity index (indexes into `entitiesUIDs`). Values must be positive. */
+  /**
+   * The list of relationship group's destination entity index (indexes into `entitiesUIDs`). Values must be positive.
+   *
+   * @since 5.0
+   */
   relationshipsGroupsTo?: number[];
-  /** The list of relationships that may be used in paths (not all relationships are guaranteed to be used). The list may contain duplicate elements. */
+  /**
+   * The list of relationships that may be used in paths (not all relationships are guaranteed to be used). The list may contain duplicate elements.
+   *
+   * @since 5.0
+   */
   relationshipsGroupsUIDsBuffer?: string[];
-  /** The list of relationship group's relationship end indices (indexes into `relationshipsGroupsUIDsBuffer`). Values must be positive. */
+  /**
+   * The list of relationship group's relationship end indices (indexes into `relationshipsGroupsUIDsBuffer`). Values must be positive.
+   *
+   * @since 5.0
+   */
   relationshipsGroupsUIDsEndIndex?: number[];
-  /** The list of relationships destination entity index (indexes into `entitiesUIDs`). */
+  /**
+   * The list of relationships destination entity index (indexes into `entitiesUIDs`).
+   *
+   * @since 5.0
+   */
   relationshipsTo?: number[];
-  /** A list parallel to `RelationshipsGroupsUIDsBuffer` representing relationship type indices. If RelationshipTypes[i] >= 0, RelationshipsGroupsUIDsBuffer[i] has type IndexedRelationshipTypes[RelationshipTypes[i]], otherwise the relationship has been deleted after the find path operation. */
+  /**
+   * A list parallel to `RelationshipsGroupsUIDsBuffer` representing relationship type indices. If RelationshipTypes[i] >= 0, RelationshipsGroupsUIDsBuffer[i] has type IndexedRelationshipTypes[RelationshipTypes[i]], otherwise the relationship has been deleted after the find path operation.
+   *
+   * @since 5.0
+   */
   relationshipTypes?: number[];
-  /** "CIMKGPaths" */
+  /**
+   * "CIMKGPaths"
+   *
+   * @since 5.0
+   */
   type: "CIMKGPaths";
 }

package/rest/knowledgeGraph/toolService/findPaths/CIMKGTraversalDirection.d.ts

@@ -3,7 +3,7 @@ import type { JSONSupport, JSONSupportMixinProperties } from "../../../../core/J
 export interface CIMKGTraversalDirectionProperties extends JSONSupportMixinProperties, Partial<Pick<CIMKGTraversalDirection, "relationshipTypeName" | "traversalDirectionType">> {}
 
 /**
- * The {@link rest/knowledgGraph/toolSettings/findPaths/CIMFilteredFindPathsConfiguration#traversalDirection traversal directions}
+ * The [traversal directions](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsConfiguration.html#traversalDirections)
  * that specify how relationships are traversed along paths between the
  * [origin](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsConfiguration.html#originEntities)
  * and [destination](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-toolService-findPaths-CIMFilteredFindPathsConfiguration.html#destinationEntities).

package/rest/knowledgeGraph/wasmInterface/KnowledgeWasmInterface.d.ts

@@ -1,3 +1,4 @@
 import type BaseGeometry from "../../../geometry/Geometry.js";
 
+/** @since 5.0 */
 export type ValidBindParameterType = Record<string, any> | number | bigint | string | Date | BaseGeometry | Array<ValidBindParameterType>;

package/rest/knowledgeGraph/wasmInterface/WasmDataModelWrapperInterfaces.d.ts

@@ -1,18 +1,27 @@
 
+/** @since 5.0 */
 export type NamedObjectType = "Regular" | "Provenance" | "Document";
 
+/** @since 5.0 */
 export type EsriFieldType = "esriFieldTypeSmallInteger" | "esriFieldTypeInteger" | "esriFieldTypeSingle" | "esriFieldTypeDouble" | "esriFieldTypeString" | "esriFieldTypeDate" | "esriFieldTypeOID" | "esriFieldTypeGeometry" | "esriFieldTypeBlob" | "esriFieldTypeRaster" | "esriFieldTypeGUID" | "esriFieldTypeGlobalID" | "esriFieldTypeXML" | "esriFieldTypeBigInteger" | "esriFieldTypeDateOnly" | "esriFieldTypeTimeOnly" | "esriFieldTypeTimestampOffset";
 
+/** @since 5.0 */
 export type EsriGeometryType = "esriGeometryNull" | "esriGeometryPoint" | "esriGeometryMultipoint" | "esriGeometryPolyline" | "esriGeometryPolygon" | "esriGeometryEnvelope" | "esriGeometryAny" | "esriGeometryMultiPatch";
 
+/** @since 5.0 */
 export type EsriUuidMethodHintType = "esriMethodHintUNSPECIFIED" | "esriUUIDESRI" | "esriUUIDRFC4122";
 
+/** @since 5.0 */
 export type EsriNamedTypeCategories = "esriTypeUNSPECIFIED" | "esriTypeEntity" | "esriTypeRelationship" | "esriTypeBoth" | "esriTypeMetaEntityProvenance";
 
+/** @since 5.0 */
 export type EsriGraphPropertyRoles = "esriGraphPropertyUNSPECIFIED" | "esriGraphPropertyRegular" | "esriGraphPropertyDocumentName" | "esriGraphPropertyDocumentTitle" | "esriGraphPropertyDocumentUrl" | "esriGraphPropertyDocumentText" | "esriGraphPropertyDocumentKeywords" | "esriGraphPropertyDocumentContentType" | "esriGraphPropertyDocumentMetadata" | "esriGraphPropertyDocumentFileExtension" | "esriGraphPropertyProvenanceInstanceId" | "esriGraphPropertyProvenanceSourceType" | "esriGraphPropertyProvenanceSourceName" | "esriGraphPropertyProvenanceSource" | "esriGraphPropertyProvenanceComment" | "esriGraphPropertyProvenanceTypeName" | "esriGraphPropertyProvenancePropertyName";
 
+/** @since 5.0 */
 export type EsriIdentifierInfoTypes = "esriIdentifierInfoTypeUNSPECIFIED" | "esriIdentifierInfoTypeDatabaseNative" | "esriIdentifierInfoTypeUniformProperty";
 
+/** @since 5.0 */
 export type EsriMergePolicyTypes = "esriMergePolicyType_UNSPECIFIED" | "esriMergePolicyTypeSumValues" | "esriMergePolicyTypeAreaWeighted" | "esriMergePolicyTypeDefaultValue";
 
+/** @since 5.0 */
 export type EsriSplitPolicyTypes = "esriSplitPolicyType_UNSPECIFIED" | "esriSplitPolicyTypeGeometryRatio" | "esriSplitPolicyTypeDuplicate" | "esriSplitPolicyTypeDefaultValue";

package/rest/knowledgeGraphService.d.ts

@@ -1,8 +1,8 @@
 /**
  * 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.
+ * Another resource is the [data model](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-DataModel.html) that defines the [entity types](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-EntityType.html)
+ * and [relationship types](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-RelationshipType.html) 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
@@ -273,7 +273,7 @@ export interface ExecuteAddNamedTypesNamedTypes {
  * // use fetchKnowledgeGraph() to retrieve the knowledge graph
  * // Delete the type, update the data model and get the updated graph.
  * knowledgeGraphModule
- *   .executeDeleteNamedTypes(graph,"knows")
+ *   .executeDeleteNamedType(graph,"knows")
  *       .then((response) => {
  *          graph = response.updatedKnowledgeGraph;
  *       })
@@ -472,7 +472,7 @@ export function executeQuery(graph: KnowledgeGraph, queryArguments: GraphQuery,
  * HTTP GET or JSON POST body. This is especially important when trying to do a query on a very large argument,
  * such as a large set of Ids or intersecting a complex geometry.
  *
- * The {@link rest/knowledgeGraph/Entities} and {@link rest/knowledgeGraph/Relationships}
+ * The [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)
  * in the graph are queried by sending an Esri implementation of [openCypher](https://opencypher.org/) query.
  *
  * @param graph - The [knowledge graph](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-KnowledgeGraph.html) associated with the service.