@arcgis/core 5.1.0-next.18 → 5.1.0-next.19

package/networks/support/UNTraceConfiguration.d.ts

@@ -1,5 +1,6 @@
 import type TraceConfiguration from "./TraceConfiguration.js";
 import type { ClonableMixin } from "../../core/Clonable.js";
+import type { AssetJSON, BarrierJSON, FunctionBarrierJSON, NearestNeighborJSON, PropagatorJSON } from "./jsonTypes.js";
 import type { TraceConfigurationProperties } from "./TraceConfiguration.js";
 
 export interface UNTraceConfigurationProperties extends TraceConfigurationProperties, Partial<Pick<UNTraceConfiguration, "allowIndeterminateFlow" | "arcadeExpressionBarrier" | "circuitName" | "diagramTemplateName" | "domainNetworkName" | "filterBarriers" | "filterBitsetNetworkAttributeName" | "filterFunctionBarriers" | "filterScope" | "includeContainers" | "includeContent" | "includeIsolated" | "includeStructures" | "includeUpToFirstSpatialContainer" | "inferConnectivity" | "maxHops" | "nearestNeighbor" | "numPaths" | "outputFilterCategories" | "outputFilters" | "propagators" | "subnetworkName" | "targetTierName" | "tierName" | "validateLocatability">> {}
@@ -66,11 +67,11 @@ export default class UNTraceConfiguration extends UNTraceConfigurationSuperclass
    */
   accessor domainNetworkName: string | null | undefined;
   /** An array of objects representing specific categories or network attributes where the trace will stop. */
-  accessor filterBarriers: any[];
+  accessor filterBarriers: BarrierJSON[];
   /** Ensures the trace results include any bit that is set in the starting points for the network attribute. */
   accessor filterBitsetNetworkAttributeName: string | null | undefined;
   /** An array of objects representing filter function barriers. */
-  accessor filterFunctionBarriers: any[];
+  accessor filterFunctionBarriers: FunctionBarrierJSON[];
   /**
    * Specifies where the filter will be applied.
    *
@@ -114,7 +115,7 @@ export default class UNTraceConfiguration extends UNTraceConfigurationSuperclass
    */
   accessor maxHops: number | null | undefined;
   /** Specifies the parameters needed for calculating nearest neighbors. Nearest neighbor is used to return a number of features of a certain type within a given distance. */
-  accessor nearestNeighbor: any | null | undefined;
+  accessor nearestNeighbor: NearestNeighborJSON | null | undefined;
   /**
    * Specifies the maximum number of paths that will be returned between
    * a given set of starting points and stopping points for a valid path.
@@ -128,13 +129,13 @@ export default class UNTraceConfiguration extends UNTraceConfigurationSuperclass
   /** An array of objects representing the output filter categories. */
   accessor outputFilterCategories: Object[];
   /** An array of objects used to control what is returned in the results of a trace. */
-  accessor outputFilters: any[];
+  accessor outputFilters: AssetJSON[];
   /**
    * A propagator defines the propagation of a network attribute along a traversal and provides a filter to stop traversal. Propagators are only applicable to subnetwork-based traces (subnetwork, subnetworksource, upstream, or downstream).
    *
    * @see [Attribute propagation - ArcGIS Pro](https://pro.arcgis.com/en/pro-app/latest/help/data/utility-network/attribute-propagation.htm)
    */
-  accessor propagators: any[];
+  accessor propagators: PropagatorJSON[];
   /** Specifies the name of the [subnetwork](https://pro.arcgis.com/en/pro-app/latest/help/data/utility-network/subnetworks.htm) where the trace will be run. */
   accessor subnetworkName: string | null | undefined;
   /**

package/networks/support/jsonTypes.d.ts

@@ -483,6 +483,311 @@ export interface NetworkDataElementJSON {
   serviceTerritoryFeatureLayerId: number;
 }
 
+/** @since 5.0 */
+export type FunctionType = "add" | "subtract" | "average" | "count" | "min" | "max";
+
+/** @since 5.0 */
+export type ConditionType = "networkAttribute" | "category";
+
+/** @since 5.0 */
+export type OperatorType = "equal" | "notEqual" | "greaterThan" | "greaterThanEqual" | "lessThan" | "lessThanEqual" | "includesTheValues" | "doesNotIncludeTheValues" | "includesAny" | "doesNotIncludeAny";
+
+/**
+ * Contains the [Barrier](https://pro.arcgis.com/en/pro-app/latest/help/data/utility-network/barriers.htm) information in JSON format.
+ *
+ * @since 5.0
+ */
+export interface BarrierJSON {
+  /**
+   * The name of the barrier.
+   *
+   * @since 5.0
+   */
+  name: string;
+  /**
+   * The type of the barrier.
+   *
+   * @since 5.0
+   */
+  type: ConditionType;
+  /**
+   * The type of the operator used in the barrier.
+   *
+   * @since 5.0
+   */
+  operator: OperatorType;
+  /**
+   * The value used by the barrier when evaluating network attributes or categories.
+   *
+   * @since 5.0
+   */
+  value: string;
+  /**
+   * Indicates whether this barrier is combined with other barriers using OR (`true`) or AND (`false`).
+   *
+   * @since 5.0
+   */
+  combineUsingOr: boolean;
+  /**
+   * Indicates whether the barrier evaluates a specific value.
+   *
+   * @since 5.0
+   */
+  isSpecificValue: boolean;
+}
+
+/**
+ * Contains the condition information in JSON format. Conditions are used to define the criteria for barriers in a utility network trace.
+ *
+ * @since 5.0
+ */
+export interface ConditionJSON {
+  /**
+   * The name of the condition.
+   *
+   * @since 5.0
+   */
+  name: string;
+  /**
+   * The type of the condition.
+   *
+   * @since 5.0
+   */
+  type: ConditionType;
+  /**
+   * The type of the operator used in the condition.
+   *
+   * @since 5.0
+   */
+  operator: OperatorType;
+  /**
+   * The value used by the condition when evaluating network attributes or categories.
+   *
+   * @since 5.0
+   */
+  value: string;
+  /**
+   * Indicates whether this condition is combined with other conditions using OR (`true`) or AND (`false`).
+   *
+   * @since 5.0
+   */
+  combineUsingOr: boolean;
+  /**
+   * Indicates whether the condition evaluates a specific value.
+   *
+   * @since 5.0
+   */
+  isSpecificValue: boolean;
+}
+
+/**
+ * Contains the output condition information in JSON format. Output conditions define which traced features are returned.
+ *
+ * @since 5.0
+ */
+export interface OutputConditionJSON {
+  /**
+   * The name of the output condition.
+   *
+   * @since 5.0
+   */
+  name: string;
+  /**
+   * The type of the output condition.
+   *
+   * @since 5.0
+   */
+  type: ConditionType;
+  /**
+   * The type of the operator used in the output condition.
+   *
+   * @since 5.0
+   */
+  operator: OperatorType;
+  /**
+   * The value used by the output condition when evaluating network attributes or categories.
+   *
+   * @since 5.0
+   */
+  value: string;
+  /**
+   * Indicates whether this output condition is combined with other conditions using OR (`true`) or AND (`false`).
+   *
+   * @since 5.0
+   */
+  combineUsingOr: boolean;
+  /**
+   * Indicates whether the output condition evaluates a specific value.
+   *
+   * @since 5.0
+   */
+  isSpecificValue: boolean;
+}
+
+/**
+ * Contains the [function](https://pro.arcgis.com/en/pro-app/latest/help/data/utility-network/configure-a-trace.htm#ESRI_SECTION1_383BDD7175084697A7E771090A410CBB) information in JSON format.
+ *
+ * @since 5.0
+ */
+export interface FunctionJSON {
+  /**
+   * The type of function used for the calculation.
+   *
+   * @since 5.0
+   */
+  functionType: FunctionType;
+  /**
+   * The network attribute name used by the function.
+   *
+   * @since 5.0
+   */
+  networkAttributeName: string;
+  /**
+   * The set of conditions used to filter elements included in the function calculation.
+   *
+   * @since 5.0
+   */
+  conditions: ConditionJSON[];
+}
+
+/**
+ * Contains the [function barrier](https://pro.arcgis.com/en/pro-app/latest/help/data/utility-network/barriers.htm#ESRI_SECTION1_F224BC2C2FC3488D840952275B4FDB35) information in JSON format.
+ *
+ * @since 5.0
+ */
+export interface FunctionBarrierJSON {
+  /**
+   * The type of function used for evaluating the barrier.
+   *
+   * @since 5.0
+   */
+  functionType: FunctionType;
+  /**
+   * The network attribute name used by the function barrier.
+   *
+   * @since 5.0
+   */
+  networkAttributeName: string;
+  /**
+   * The type of the operator used in the function barrier.
+   *
+   * @since 5.0
+   */
+  operator: OperatorType;
+  /**
+   * The value used to evaluate the function barrier.
+   *
+   * @since 5.0
+   */
+  value: string;
+}
+
+/**
+ * Contains asset information in JSON format.
+ *
+ * @since 5.0
+ */
+export interface AssetJSON {
+  /**
+   * The network source ID of the asset.
+   *
+   * @since 5.0
+   */
+  networkSourceId: number;
+  /**
+   * The asset group code of the asset.
+   *
+   * @since 5.0
+   */
+  assetGroupCode: number;
+  /**
+   * The asset type code of the asset.
+   *
+   * @since 5.0
+   */
+  assetTypeCode: number;
+}
+
+/**
+ * The properties below are returned by the nearestNeighbor object when using `Describe` on a utility network.
+ *
+ * @since 5.0
+ */
+export interface NearestNeighborJSON {
+  /**
+   * If the filter nearest function is being used, this is the value of the number of features to be returned.
+   * If the filter nearest function is not being used, this property returns a -1 value.
+   *
+   * @since 5.0
+   */
+  count: number;
+  /**
+   * If the filter nearest function is being used, this is the name of the network attribute that is being used to calculate the cost.
+   * If the filter nearest function is not being used, this property returns an empty string.
+   *
+   * @since 5.0
+   */
+  costNetworkAttributeName: string;
+  /**
+   * If the filter nearest function is being used, these are the names of the categories that will be returned.
+   * If the filter nearest function is not being used, this property returns an empty list.
+   *
+   * @since 5.0
+   */
+  nearestCategories: string[];
+  /**
+   * The nearestAssets object. If the filter nearest function is being used, these are the asset groups and asset types that will be returned.
+   * If the filter nearest function is not being used, this property returns an empty list.
+   *
+   * @since 5.0
+   */
+  nearestAssets: AssetJSON[];
+}
+
+/**
+ * Propagators define how values are propagated during a trace.
+ *
+ * @since 5.0
+ */
+export interface PropagatorJSON {
+  /**
+   * The name of the network attribute used to filter the propagator condition.
+   *
+   * @since 5.0
+   */
+  networkAttributeName: string;
+  /**
+   * The network attribute used for substitution.
+   *
+   * @since 5.0
+   */
+  substitutionAttributeName: string;
+  /**
+   * The type of function used for propagation, such as `bitwiseAnd`, `min`, or `max`.
+   *
+   * @since 5.0
+   */
+  propagatorfunctionType: "bitwiseAnd" | "min" | "max";
+  /**
+   * The operator used for propagation (for example, equal to or less than).
+   *
+   * @since 5.0
+   */
+  operator: OperatorType;
+  /**
+   * The specific value of the network attribute or category used for propagation.
+   *
+   * @since 5.0
+   */
+  value: string;
+  /**
+   * The name of the field used to store calculated propagated values.
+   *
+   * @since 5.0
+   */
+  propagatedAttributeName: string;
+}
+
 /**
  * ResultTypeJSON specifies the type of results to return after running a trace.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arcgis/core",
-  "version": "5.1.0-next.18",
+  "version": "5.1.0-next.19",
   "homepage": "https://js.arcgis.com",
   "description": "ArcGIS Maps SDK for JavaScript: A complete 2D and 3D mapping and data visualization API",
   "keywords": [
@@ -19,13 +19,13 @@
   "license": "SEE LICENSE IN LICENSE.md",
   "dependencies": {
     "@amcharts/amcharts5": "~5.15.5",
-    "@arcgis/toolkit": "^5.0.0-next.161",
+    "@arcgis/toolkit": "^5.0.0-next.169",
     "@esri/arcgis-html-sanitizer": "~4.1.0",
     "@esri/calcite-components": "^5.0.0",
     "@vaadin/grid": "~25.0.3",
     "@zip.js/zip.js": "~2.8.16",
     "luxon": "~3.7.2",
-    "marked": "~17.0.1",
+    "marked": "~17.0.2",
     "tslib": "^2.8.1"
   },
   "type": "module"

package/popup/content/AttachmentsContent.d.ts

@@ -28,7 +28,7 @@ export interface AttachmentsContentProperties extends BaseContentProperties, Par
  *
  * | Preview view | List view |
  * | ---- | ---- |
- * | ![popuptemplate-attachments-element-preview](https://developers.arcgis.com/javascript/latest/assets/images/apiref/widgets/popup/popuptemplate-attachments-element-preview.png)| ![popuptemplate-attachments-element-list](https://developers.arcgis.com/javascript/latest/assets/images/apiref/widgets/popup/popuptemplate-attachments-element-list.png) |
+ * | ![popuptemplate-attachments-element-preview](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/popup/popuptemplate-attachments-element-preview.png)| ![popuptemplate-attachments-element-list](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/popup/popuptemplate-attachments-element-list.png) |
  *
  * @since 4.11
  * @see [PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/)

package/popup/content/BarChartMediaInfo.d.ts

@@ -6,7 +6,7 @@ export interface BarChartMediaInfoProperties extends ChartMediaInfoProperties {}
 /**
  * A `BarChartMediaInfo` is a type of chart media element that represents a bar chart displayed within a popup.
  *
- * ![popuptemplate-media-element-barchart](https://developers.arcgis.com/javascript/latest/assets/images/apiref/widgets/popup/popuptemplate-media-element-barchart.png)
+ * ![popuptemplate-media-element-barchart](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/popup/popuptemplate-media-element-barchart.png)
  *
  * @since 4.11
  * @see [PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/)

package/popup/content/ColumnChartMediaInfo.d.ts

@@ -7,7 +7,7 @@ export interface ColumnChartMediaInfoProperties extends ChartMediaInfoProperties
  * A `ColumnChartMediaInfo` is a type of chart media element
  * that represents a column chart displayed within a popup.
  *
- * ![popuptemplate-media-element-columnchart](https://developers.arcgis.com/javascript/latest/assets/images/apiref/widgets/popup/popuptemplate-media-element-columnchart.png)
+ * ![popuptemplate-media-element-columnchart](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/popup/popuptemplate-media-element-columnchart.png)
  *
  * @since 4.11
  * @see [PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/)

package/popup/content/FieldsContent.d.ts

@@ -18,7 +18,7 @@ export interface FieldsContentProperties extends BaseContentProperties, Partial<
  * it will revert to whatever may be set within the [PopupTemplate.fieldInfos](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/#fieldInfos)
  * property.
  *
- * ![popuptemplate-fields-element](https://developers.arcgis.com/javascript/latest/assets/images/apiref/widgets/popup/popuptemplate-fields-element.png)
+ * ![popuptemplate-fields-element](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/popup/popuptemplate-fields-element.png)
  *
  * @since 4.11
  * @see [PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/)

package/popup/content/ImageMediaInfo.d.ts

@@ -11,7 +11,7 @@ export interface ImageMediaInfoProperties extends MediaInfoProperties, Partial<P
 /**
  * An `ImageMediaInfo` is a type of media element that represents images to display within a popup.
  *
- * ![popuptemplate-media-element-image](https://developers.arcgis.com/javascript/latest/assets/images/apiref/widgets/popup/popuptemplate-media-element-image.png)
+ * ![popuptemplate-media-element-image](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/popup/popuptemplate-media-element-image.png)
  *
  * @since 4.11
  * @see [PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/)

package/popup/content/LineChartMediaInfo.d.ts

@@ -7,7 +7,7 @@ export interface LineChartMediaInfoProperties extends ChartMediaInfoProperties {
  * A `LineChartMediaInfo` is a type of chart media element
  * that represents a line chart displayed within a popup.
  *
- * ![popuptemplate-media-element-linechart](https://developers.arcgis.com/javascript/latest/assets/images/apiref/widgets/popup/popuptemplate-media-element-linechart.png)
+ * ![popuptemplate-media-element-linechart](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/popup/popuptemplate-media-element-linechart.png)
  *
  * @since 4.11
  * @see [PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/)

package/popup/content/MediaContent.d.ts

@@ -33,7 +33,7 @@ export type PopupContentMediaInfoUnion = BarChartMediaInfo | ColumnChartMediaInf
  * [Binning](https://developers.arcgis.com/javascript/latest/references/core/layers/support/FeatureReductionBinning/) and [clustering](https://developers.arcgis.com/javascript/latest/references/core/layers/support/FeatureReductionCluster/) popup charts are also based on the renderer colors.
  * However, popup charts only respect the colors from the [pie chart](https://developers.arcgis.com/javascript/latest/references/core/renderers/PieChartRenderer/) renderer when clustering is configured.
  *
- * ![popuptemplate-media-element](https://developers.arcgis.com/javascript/latest/assets/images/apiref/widgets/popup/popuptemplate-media-element.png)
+ * ![popuptemplate-media-element](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/popup/popuptemplate-media-element.png)
  *
  * @since 4.11
  * @see [PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/)

package/popup/content/PieChartMediaInfo.d.ts

@@ -6,7 +6,7 @@ export interface PieChartMediaInfoProperties extends ChartMediaInfoProperties {}
 /**
  * A `PieChartMediaInfo` is a type of chart media element that represents a pie chart displayed within a popup.
  *
- * ![popuptemplate-media-element-piechart](https://developers.arcgis.com/javascript/latest/assets/images/apiref/widgets/popup/popuptemplate-media-element-piechart.png)
+ * ![popuptemplate-media-element-piechart](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/popup/popuptemplate-media-element-piechart.png)
  *
  * @since 4.11
  * @see [PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/)

package/popup/content/RelationshipContent.d.ts

@@ -23,7 +23,7 @@ export interface RelationshipContentProperties extends BaseContentProperties, Pa
  *
  * | Origin Feature | Related Destination Feature |
  * | -------------- | ------------- |
- * | ![origin feature](https://developers.arcgis.com/javascript/latest/assets/images/apiref/widgets/popup/popuptemplate-origin-feature.png) | ![destination feature](https://developers.arcgis.com/javascript/latest/assets/images/apiref/widgets/popup/popuptemplate-destination-feature.png) |
+ * | ![origin feature](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/popup/popuptemplate-origin-feature.png) | ![destination feature](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/popup/popuptemplate-destination-feature.png) |
  *
  * > [!WARNING]
  * >

package/popup/content/TextContent.d.ts

@@ -8,7 +8,7 @@ export interface TextContentProperties extends BaseContentProperties, Partial<Pi
  * content. The text may reference values returned from a field attribute or an
  * [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expression defined in a PopupTemplate's [PopupTemplate.expressionInfos](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/#expressionInfos) property.
  *
- * ![popuptemplate-text-element](https://developers.arcgis.com/javascript/latest/assets/images/apiref/widgets/popup/popuptemplate-text-element.png).
+ * ![popuptemplate-text-element](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/popup/popuptemplate-text-element.png).
  *
  * @since 4.11
  * @see [PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/)