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

package/networks/support/jsonTypes.d.ts

@@ -1,7 +1,9 @@
 import type UNTraceConfiguration from "./UNTraceConfiguration.js";
 
+/** @since 5.0 */
 export type UtilityNetworkFeatureClassUsageType = "esriUNFCUTDevice" | "esriUNFCUTJunction" | "esriUNFCUTLine" | "esriUNFCUTAssembly" | "esriUNFCUTSubnetLine" | "esriUNFCUTStructureJunction" | "esriUNFCUTStructureLine" | "esriUNFCUTStructureBoundary" | "esriUNFCUTJunctionObject" | "esriUNFCUTEdgeObject" | "esriUNFCUTStructureJunctionObject" | "esriUNFCUTStructureEdgeObject" | "esriUNFCUTCircuit" | "esriUNFCUTCircuitSection" | "esriUNFCUTSubcircuit";
 
+/** @since 5.0 */
 export type PolicyType = "esriDPTUnitApportioned" | "esriDPTDefaultValue" | "esriCPTSumValues" | "esriCPTDefaultValue";
 
 /**
@@ -10,9 +12,17 @@ export type PolicyType = "esriDPTUnitApportioned" | "esriDPTDefaultValue" | "esr
  * @since 4.34
  */
 export interface UnitIdentifier {
-  /** The element's global ID. */
+  /**
+   * The element's global ID.
+   *
+   * @since 5.0
+   */
   globalId: string;
-  /** The element's network source ID. */
+  /**
+   * The element's network source ID.
+   *
+   * @since 5.0
+   */
   sourceId: number;
 }
 
@@ -22,13 +32,29 @@ export interface UnitIdentifier {
  * @since 4.34
  */
 export interface UnitRange {
-  /** The object consuming the unit identifiers in this range. */
+  /**
+   * The object consuming the unit identifiers in this range.
+   *
+   * @since 5.0
+   */
   content?: UnitIdentifier | null;
-  /** The unit offset in the grouped object. */
+  /**
+   * The unit offset in the grouped object.
+   *
+   * @since 5.0
+   */
   firstUnit: number;
-  /** Whether the unit identifier range is a gap, i.e., is not utilized. */
+  /**
+   * Whether the unit identifier range is a gap, i.e., is not utilized.
+   *
+   * @since 5.0
+   */
   isGap: boolean;
-  /** The last unit in the unit identifier range. */
+  /**
+   * The last unit in the unit identifier range.
+   *
+   * @since 5.0
+   */
   lastUnit: number;
 }
 
@@ -38,71 +64,165 @@ export interface UnitRange {
  * @since 4.34
  */
 export interface CircuitExportResult {
-  /** Indicates if the circuit has been logically deleted. */
+  /**
+   * Indicates if the circuit has been logically deleted.
+   *
+   * @since 5.0
+   */
   circuitHasBeenDeleted: boolean;
-  /** The name of the exported circuit. */
+  /**
+   * The name of the exported circuit.
+   *
+   * @since 5.0
+   */
   circuitName: string;
-  /** Optional error information if the export failed. */
+  /**
+   * Optional error information if the export failed.
+   *
+   * @since 5.0
+   */
   error?: CircuitExportResultError;
-  /** Indicates if the export was successful. */
+  /**
+   * Indicates if the export was successful.
+   *
+   * @since 5.0
+   */
   success: boolean;
-  /** The location of the exported circuit JSON file. */
+  /**
+   * The location of the exported circuit JSON file.
+   *
+   * @since 5.0
+   */
   url: string;
 }
 
+/** @since 5.0 */
 export interface CircuitExportResultError {
-  /** Additional error details. */
+  /**
+   * Additional error details.
+   *
+   * @since 5.0
+   */
   details: string[];
-  /** Extended error code. */
+  /**
+   * Extended error code.
+   *
+   * @since 5.0
+   */
   extendedCode: number;
-  /** Error message. */
+  /**
+   * Error message.
+   *
+   * @since 5.0
+   */
   message: string;
 }
 
 /**
  * AssetTypeJSON represents [asset type](https://pro.arcgis.com/en/pro-app/latest/help/data/utility-network/utility-feature-classification.htm#GUID-A4CCEB96-C4F8-459B-A763-FF6A5791F663).
  * Attribute domains are assigned on the asset type field at the subtype level for each network class. It represents the minor classification of the utility network classes.
+ *
+ * @since 5.0
  */
 export interface AssetTypeJSON {
-  /** The unique code for the asset type. */
+  /**
+   * The unique code for the asset type.
+   *
+   * @since 5.0
+   */
   assetTypeCode: number;
-  /** The name of the asset type. */
+  /**
+   * The name of the asset type.
+   *
+   * @since 5.0
+   */
   assetTypeName?: string;
-  /** The connectivity policy applied to the asset type. */
+  /**
+   * The connectivity policy applied to the asset type.
+   *
+   * @since 5.0
+   */
   connectivityPolicy?: string;
-  /** Indicates if terminal configurations are supported for the asset type. */
+  /**
+   * Indicates if terminal configurations are supported for the asset type.
+   *
+   * @since 5.0
+   */
   isTerminalConfigurationSupported?: boolean;
-  /** The terminal configuration ID associated with the asset type, if applicable. */
+  /**
+   * The terminal configuration ID associated with the asset type, if applicable.
+   *
+   * @since 5.0
+   */
   terminalConfigurationId?: number;
 }
 
 /**
  * AssetGroupJSON represents the [asset group](https://pro.arcgis.com/en/pro-app/latest/help/data/utility-network/utility-feature-classification.htm#GUID-A4CCEB96-C4F8-459B-A763-FF6A5791F663).
  * The asset group is the subtype field and represents the major classification of utility network classes.
+ *
+ * @since 5.0
  */
 export interface AssetGroupJSON {
-  /** The unique code for the asset group. */
+  /**
+   * The unique code for the asset group.
+   *
+   * @since 5.0
+   */
   assetGroupCode: number;
-  /** The asset group name. */
+  /**
+   * The asset group name.
+   *
+   * @since 5.0
+   */
   assetGroupName?: string;
-  /** An array of asset types associated with the asset group. */
+  /**
+   * An array of asset types associated with the asset group.
+   *
+   * @since 5.0
+   */
   assetTypes: AssetTypeJSON[];
 }
 
+/** @since 5.0 */
 export interface CircuitSourceJSON {
-  /** The layer id of the point layer. */
+  /**
+   * The layer id of the point layer.
+   *
+   * @since 5.0
+   */
   layerId: number;
-  /** The network source id of the layer. */
+  /**
+   * The network source id of the layer.
+   *
+   * @since 5.0
+   */
   sourceId: number;
-  /** The usage type of the edge source. */
+  /**
+   * The usage type of the edge source.
+   *
+   * @since 5.0
+   */
   utilityNetworkFeatureClassUsageType: UtilityNetworkFeatureClassUsageType;
 }
 
-/** JunctionSourceJSON represents the point layers that participate in the utility network service. */
+/**
+ * JunctionSourceJSON represents the point layers that participate in the utility network service.
+ *
+ * @since 5.0
+ */
 export interface NetworkSourceJSON extends CircuitSourceJSON {
-  /** The asset group attribute values for the point layer. */
+  /**
+   * The asset group attribute values for the point layer.
+   *
+   * @since 5.0
+   */
   assetGroups: AssetGroupJSON[];
-  /** Supported properties for the edge source. */
+  /**
+   * Supported properties for the edge source.
+   *
+   * @since 5.0
+   */
   supportedProperties: string[];
 }
 
@@ -112,86 +232,210 @@ export interface NetworkSourceJSON extends CircuitSourceJSON {
  * @since 4.34
  */
 export interface DomainNetworkJSON {
-  /** Circuit properties for telecom networks. */
+  /**
+   * Circuit properties for telecom networks.
+   *
+   * @since 5.0
+   */
   circuitProperties?: CircuitPropertiesJSON | null;
-  /** An array of circuit source objects for telecom networks. */
+  /**
+   * An array of circuit source objects for telecom networks.
+   *
+   * @since 5.0
+   */
   circuitSources?: CircuitSourceJSON[] | null;
-  /** An array of objects to describe color schemes in a telecom domain network. */
+  /**
+   * An array of objects to describe color schemes in a telecom domain network.
+   *
+   * @since 5.0
+   */
   colorSchemes?: ColorSchemeJSON[] | null;
-  /** An array of objects describing combine policies. */
+  /**
+   * An array of objects describing combine policies.
+   *
+   * @since 5.0
+   */
   combinePolicies?: PolicyJSON[] | null;
-  /** An array of objects describing divide policies for a telecom domain network. */
+  /**
+   * An array of objects describing divide policies for a telecom domain network.
+   *
+   * @since 5.0
+   */
   dividePolicies?: PolicyJSON[] | null;
-  /** The name of the domain network. */
+  /**
+   * The name of the domain network.
+   *
+   * @since 5.0
+   */
   domainNetworkName: string;
-  /** An array of network source objects that represent the sources of edge features. */
+  /**
+   * An array of network source objects that represent the sources of edge features.
+   *
+   * @since 5.0
+   */
   edgeSources: NetworkSourceJSON[];
-  /** Indicates if this domain network is a structure network. */
+  /**
+   * Indicates if this domain network is a structure network.
+   *
+   * @since 5.0
+   */
   isStructureNetwork: boolean;
-  /** Indicates if this domain network is a telecom domain network. */
+  /**
+   * Indicates if this domain network is a telecom domain network.
+   *
+   * @since 5.0
+   */
   isTelecomNetwork: boolean;
-  /** An array of network source objects that represent the sources of junction features. */
+  /**
+   * An array of network source objects that represent the sources of junction features.
+   *
+   * @since 5.0
+   */
   junctionSources: NetworkSourceJSON[];
-  /** The layer ID of the subnetwork layer. Null if no subnetwork layer is defined, e.g., a telecom domain network. */
+  /**
+   * The layer ID of the subnetwork layer. Null if no subnetwork layer is defined, e.g., a telecom domain network.
+   *
+   * @since 5.0
+   */
   subnetworkLayerId?: number | null;
-  /** An array of tier definitions used to organize the network into hierarchical levels. Null if no tiers are defined, e.g., a telecom domain network. */
+  /**
+   * An array of tier definitions used to organize the network into hierarchical levels. Null if no tiers are defined, e.g., a telecom domain network.
+   *
+   * @since 5.0
+   */
   tiers?: TierJSON[] | null;
   /**
    * A UNTraceConfiguration object that defines the trace configuration for the domain network.
    *   This configuration includes parameters specific to utility networks.
+   *
+   * @since 5.0
    */
   traceConfiguration?: UNTraceConfiguration | null;
 }
 
+/** @since 5.0 */
 export interface CircuitPropertiesJSON {
-  /** The items in the property set. */
+  /**
+   * The items in the property set.
+   *
+   * @since 5.0
+   */
   propertySetItems: (string | boolean)[];
-  /** The type of the property set. */
+  /**
+   * The type of the property set.
+   *
+   * @since 5.0
+   */
   type: "PropertySet";
 }
 
+/** @since 5.0 */
 export interface ColorSchemeJSON {
-  /** The group delimiter. */
+  /**
+   * The group delimiter.
+   *
+   * @since 5.0
+   */
   groupDelimiter: string;
-  /** An array of objects representing color groups in the color scheme. */
+  /**
+   * An array of objects representing color groups in the color scheme.
+   *
+   * @since 5.0
+   */
   groups: ColorGroupJSON[];
-  /** The id of the color scheme. */
+  /**
+   * The id of the color scheme.
+   *
+   * @since 5.0
+   */
   id: number;
-  /** The number of levels in the color scheme. */
+  /**
+   * The number of levels in the color scheme.
+   *
+   * @since 5.0
+   */
   levels: number;
-  /** The name of the color scheme. */
+  /**
+   * The name of the color scheme.
+   *
+   * @since 5.0
+   */
   name: string;
 }
 
+/** @since 5.0 */
 export interface ColorGroupJSON {
-  /** The capacity for the color group. */
+  /**
+   * The capacity for the color group.
+   *
+   * @since 5.0
+   */
   capacity: number[];
-  /** The delimiter for the color group. */
+  /**
+   * The delimiter for the color group.
+   *
+   * @since 5.0
+   */
   delimiter: string;
-  /** The labels for the color group. */
+  /**
+   * The labels for the color group.
+   *
+   * @since 5.0
+   */
   labels: (string | number)[];
-  /** The level of the color group. */
+  /**
+   * The level of the color group.
+   *
+   * @since 5.0
+   */
   level: number;
-  /** The name of the color group. */
+  /**
+   * The name of the color group.
+   *
+   * @since 5.0
+   */
   name: string;
 }
 
+/** @since 5.0 */
 export interface PolicyJSON {
-  /** The attribute name for the policy. */
+  /**
+   * The attribute name for the policy.
+   *
+   * @since 5.0
+   */
   attributeName: string;
-  /** The policy type. */
+  /**
+   * The policy type.
+   *
+   * @since 5.0
+   */
   policy: PolicyType;
-  /** The source ID for the policy. */
+  /**
+   * The source ID for the policy.
+   *
+   * @since 5.0
+   */
   sourceId: number;
 }
 
+/** @since 5.0 */
 export interface TierJSON {
-  /** The name of the tier. */
+  /**
+   * The name of the tier.
+   *
+   * @since 5.0
+   */
   name: string;
 }
 
+/** @since 5.0 */
 export interface TerminalConfigurationJSON {
-  /** The Id that uniquely identifies the terminal configuration. */
+  /**
+   * The Id that uniquely identifies the terminal configuration.
+   *
+   * @since 5.0
+   */
   terminalConfigurationId: number;
 }
 
@@ -201,23 +445,48 @@ export interface TerminalConfigurationJSON {
  * @since 4.33
  */
 export interface NetworkDataElementJSON {
-  /** An array of domain networks included in the utility network. */
+  /**
+   * An array of domain networks included in the utility network.
+   *
+   * @since 5.0
+   */
   domainNetworks: DomainNetworkJSON[];
-  /** The name of the utility network. */
+  /**
+   * The name of the utility network.
+   *
+   * @since 5.0
+   */
   name: string;
-  /** The schema generation version number of the utility network. */
+  /**
+   * The schema generation version number of the utility network.
+   *
+   * @since 5.0
+   */
   schemaGeneration: number;
-  /** The layer Id of the feature layer representing service territories within the network. */
+  /**
+   * The layer Id of the feature layer representing service territories within the network.
+   *
+   * @since 5.0
+   */
   serviceTerritoryFeatureLayerId: number;
-  /** An array of terminal configuration objects available in the network. */
+  /**
+   * An array of terminal configuration objects available in the network.
+   *
+   * @since 5.0
+   */
   terminalConfigurations: TerminalConfigurationJSON[];
-  /** The user identity associated with the network definition. */
+  /**
+   * The user identity associated with the network definition.
+   *
+   * @since 5.0
+   */
   userIdentity: string;
 }
 
 /**
  * ResultTypeJSON specifies the type of results to return after running a trace.
  *
+ * @since 5.0
  * @example
  * // Creates a new instance of this class and initializes it with values inputted in json format. A resultTypes object is passed into the resultTypes property.
  * const traceParameters = TraceParameters.fromJSON({
@@ -246,23 +515,48 @@ export interface NetworkDataElementJSON {
  *  });
  */
 export interface ResultType {
-  /** Specifies the name of a predefined Diagram Template. */
+  /**
+   * Specifies the name of a predefined Diagram Template.
+   *
+   * @since 5.0
+   */
   diagramTemplateName: string;
-  /** Specifies whether to return geometry values in resultTypes. */
+  /**
+   * Specifies whether to return geometry values in resultTypes.
+   *
+   * @since 5.0
+   */
   includeGeometry: boolean;
-  /** Specifies whether to return propagated values in resultTypes. */
+  /**
+   * Specifies whether to return propagated values in resultTypes.
+   *
+   * @since 5.0
+   */
   includePropagatedValues: boolean;
-  /** Specifies the network attribute names. */
+  /**
+   * Specifies the network attribute names.
+   *
+   * @since 5.0
+   */
   networkAttributeNames: string[];
-  /** Specifies the types of output fields that can be generated from geoprocessing tools. */
+  /**
+   * Specifies the types of output fields that can be generated from geoprocessing tools.
+   *
+   * @since 5.0
+   */
   resultTypeFields: Object[];
-  /** Specifies the return type for the trace. `paths` and `circuits` are reserved for future use. */
+  /**
+   * Specifies the return type for the trace. `paths` and `circuits` are reserved for future use.
+   *
+   * @since 5.0
+   */
   type: "elements" | "aggregatedGeometry" | "paths" | "circuits";
 }
 
 /**
  * ValidationSetItemJSON represents the set of features and objects to validate.
  *
+ * @since 5.0
  * @example
  * const validationResult = await network.submitTopologyValidationJob(
  *   new ValidateNetworkTopologyParameters({
@@ -282,8 +576,16 @@ export interface ResultType {
  * console.log("result: ", validationResult);
  */
 export interface ValidationSetItemJSON {
-  /** An array of globalId strings to validate. */
+  /**
+   * An array of globalId strings to validate.
+   *
+   * @since 5.0
+   */
   globalIds: string[];
-  /** The network source id of the. */
+  /**
+   * The network source id of the.
+   *
+   * @since 5.0
+   */
   sourceId: number;
 }

package/networks/support/typeUtils.d.ts

@@ -1,20 +1,30 @@
 
+/** @since 5.0 */
 export type CircuitStatus = "clean" | "dirty";
 
+/** @since 5.0 */
 export type CircuitType = "physical" | "virtual";
 
+/** @since 5.0 */
 export type CircuitSectionRoleType = "start-and-end" | "start" | "midspan" | "end";
 
+/** @since 5.0 */
 export type SubcircuitState = "available" | "consumed" | "reserved";
 
+/** @since 5.0 */
 export type TraceLocationType = "starting-point" | "barrier" | "stopping-point";
 
+/** @since 5.0 */
 export type TraceType = "connected" | "upstream" | "downstream" | "shortest-path" | "subnetwork" | "subnetwork-controller" | "loops" | "isolation" | "path" | "circuit";
 
+/** @since 5.0 */
 export type AssociationType = "connectivity" | "junction-junction-connectivity" | "attachment" | "containment" | "junction-edge-from-connectivity" | "junction-edge-midspan-connectivity" | "junction-edge-to-connectivity";
 
+/** @since 5.0 */
 export type AssociationJsonType = "connectivity" | "junctionJunctionConnectivity" | "attachment" | "containment" | "junctionEdgeFromConnectivity" | "junctionEdgeMidspanConnectivity" | "junctionEdgeToConnectivity";
 
+/** @since 5.0 */
 export type AssociationListPopupType = "attachment" | "connectivity" | "container" | "content" | "structure";
 
+/** @since 5.0 */
 export type ValidationType = "normal" | "rebuild" | "force-rebuild";

package/networks/support/utils.d.ts

@@ -2,11 +2,23 @@ import type FeatureLayer from "../../layers/FeatureLayer.js";
 import type SubtypeGroupLayer from "../../layers/SubtypeGroupLayer.js";
 import type FeatureSet from "../../rest/support/FeatureSet.js";
 
-/** FeatureSetInfo represents the information for the results in the featureset. */
+/**
+ * FeatureSetInfo represents the information for the results in the featureset.
+ *
+ * @since 5.0
+ */
 export interface FeatureSetInfo {
-  /** The [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html). */
+  /**
+   * The [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html).
+   *
+   * @since 5.0
+   */
   featureSet: FeatureSet;
-  /** The [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) of the dataset. */
+  /**
+   * The [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) of the dataset.
+   *
+   * @since 5.0
+   */
   layer: FeatureLayer | SubtypeGroupLayer;
 }
 
@@ -16,10 +28,22 @@ export interface FeatureSetInfo {
  * @since 4.31
  */
 export interface LayerInfo {
-  /** The layerUrl of the feature layer. */
+  /**
+   * The layerUrl of the feature layer.
+   *
+   * @since 5.0
+   */
   layerUrl: string;
-  /** The objectIds of the elements. */
+  /**
+   * The objectIds of the elements.
+   *
+   * @since 5.0
+   */
   objectIds: number[];
-  /** The outFields of a layer. */
+  /**
+   * The outFields of a layer.
+   *
+   * @since 5.0
+   */
   outFields?: string[];
 }