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

package/tables/elements/AttributeTableRelationshipElement.d.ts

@@ -9,7 +9,7 @@ export interface AttributeTableRelationshipElementProperties extends AttributeTa
  *
  * @since 4.31
  * @see [FeatureTable](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html)
- * @see {@link tables/AttributeTableTemplate/}
+ * @see [AttributeTableTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-tables-AttributeTableTemplate.html)
  */
 export default class AttributeTableRelationshipElement extends AttributeTableRelationshipElementSuperclass {
   constructor(properties?: AttributeTableRelationshipElementProperties);

package/tables/support/FieldOrder.d.ts

@@ -1,13 +1,26 @@
 import type { ClonableMixin, ClonableMixinProperties } from "../../core/Clonable.js";
 import type { JSONSupport, JSONSupportMixinProperties } from "../../core/JSONSupport.js";
 
+/** @since 5.0 */
 export interface AttributeTableFieldOrderProperties extends JSONSupportMixinProperties, ClonableMixinProperties, Partial<Pick<AttributeTableFieldOrder, "field" | "order">> {}
 
-/** This object sets a field and sort order for how records display within the table. */
+/**
+ * This object sets a field and sort order for how records display within the table.
+ *
+ * @since 5.0
+ */
 export default abstract class AttributeTableFieldOrder extends AttributeTableFieldOrderSuperclass {
-  /** Name of a field. The value of this field will drive the sorting. */
+  /**
+   * Name of a field. The value of this field will drive the sorting.
+   *
+   * @since 5.0
+   */
   accessor field: string | null | undefined;
-  /** Indicates whether features are sorted in ascending or descending order of the field values. */
+  /**
+   * Indicates whether features are sorted in ascending or descending order of the field values.
+   *
+   * @since 5.0
+   */
   accessor order: "asc" | "desc" | null | undefined;
 }
 declare const AttributeTableFieldOrderSuperclass: typeof JSONSupport & typeof ClonableMixin

package/tables/support/tablesUtils.d.ts

@@ -2,4 +2,5 @@ import type AttributeTableAttachmentElement from "../elements/AttributeTableAtta
 import type AttributeTableFieldElement from "../elements/AttributeTableFieldElement.js";
 import type AttributeTableRelationshipElement from "../elements/AttributeTableRelationshipElement.js";
 
+/** @since 5.0 */
 export type NestedAttributeTableElement = AttributeTableAttachmentElement | AttributeTableFieldElement | AttributeTableRelationshipElement;

package/time/types.d.ts

@@ -1,8 +1,12 @@
 
+/** @since 5.0 */
 export type IANATimeZone = NonNullable<Intl.DateTimeFormatOptions["timeZone"]>;
 
+/** @since 5.0 */
 export type SystemTimeZone = "system";
 
+/** @since 5.0 */
 export type UnknownTimeZone = "unknown";
 
+/** @since 5.0 */
 export type TimeZone = IANATimeZone | SystemTimeZone | UnknownTimeZone;

package/versionManagement/VersionManagementService.d.ts

@@ -68,10 +68,7 @@ export default class VersionManagementService extends VersionManagementServiceSu
   /** Contains the value for the default version's name and GUID. */
   accessor defaultVersionIdentifier: VersionIdentifier;
   /**
-   * Indicates whether the instance has loaded. When `true`,
-   * the properties of the object can be accessed. A WebMap is considered loaded
-   * when its {@link versionManagement/VersionManagementService#layers} and {@link versionManagement/VersionManagementService#basemap} are created, but not
-   * yet loaded.
+   * Indicates whether the instance has loaded. When `true`, the properties of the object can be accessed.
    *
    * @default false
    */
@@ -247,7 +244,7 @@ export default class VersionManagementService extends VersionManagementServiceSu
    */
   getLockType(versionIdentifier: VersionIdentifier): LockType;
   /**
-   * This method will return the {@link versionManagement/VersionManagementService#versionIdentifier} given the guid of the version.
+   * This method will return the [VersionIdentifier](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-support-jsonTypes.html#VersionIdentifier) given the guid of the version.
    *
    * @param guid - GUID of version.
    * @returns Returns VersionIdentifier.
@@ -255,7 +252,7 @@ export default class VersionManagementService extends VersionManagementServiceSu
    */
   getVersionIdentifierFromGuid(guid: string): Promise<VersionIdentifier | null | undefined>;
   /**
-   * This method will return the {@link versionManagement/VersionManagementService#versionIdentifier} given the name of the version.
+   * This method will return the [VersionIdentifier](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-support-jsonTypes.html#VersionIdentifier) given the name of the version.
    *
    * @param name - Name of version.
    * @returns Returns VersionIdentifier.

package/versionManagement/VersionManager.d.ts

@@ -7,42 +7,98 @@ import type { ServiceResult, VersionIdentifier, VersionInfo, VersionInfoExtended
 import type { AccessType } from "./support/type.js";
 import type { VersionAdapter } from "./versionAdapters/types.js";
 
+/** @since 5.0 */
 export interface VersionManagerProperties extends Partial<Pick<VersionManager, "featureServiceLookup" | "serverVersionLookup" | "serviceNameLookup" | "userLookup" | "versionAdministratorLookup" | "versioningStateLookup" | "versioningStates" | "view">> {}
 
-/** Parameters used to alter a version. */
+/**
+ * Parameters used to alter a version.
+ *
+ * @since 5.0
+ */
 export interface AlterVersionParameters {
-  /** The new access permissions of the version. */
+  /**
+   * The new access permissions of the version.
+   *
+   * @since 5.0
+   */
   access?: AccessType;
-  /** The new description for the version. */
+  /**
+   * The new description for the version.
+   *
+   * @since 5.0
+   */
   description?: string;
-  /** The url of a feature service. */
+  /**
+   * The url of a feature service.
+   *
+   * @since 5.0
+   */
   featureServerUrl: string;
-  /** The new owner name of the version. */
+  /**
+   * The new owner name of the version.
+   *
+   * @since 5.0
+   */
   ownerName?: string;
-  /** The Identifier of a version. */
+  /**
+   * The Identifier of a version.
+   *
+   * @since 5.0
+   */
   versionIdentifier: VersionIdentifier;
-  /** The new name for the version. */
+  /**
+   * The new name for the version.
+   *
+   * @since 5.0
+   */
   versionName?: string;
 }
 
-/** Parameters used to create a new version. */
+/**
+ * Parameters used to create a new version.
+ *
+ * @since 5.0
+ */
 export interface CreateVersionParameters {
-  /** The access type of the new version. */
+  /**
+   * The access type of the new version.
+   *
+   * @since 5.0
+   */
   access: AccessType;
-  /** The description of the new version. */
+  /**
+   * The description of the new version.
+   *
+   * @since 5.0
+   */
   description: string;
-  /** The url of a feature service. */
+  /**
+   * The url of a feature service.
+   *
+   * @since 5.0
+   */
   featureServerUrl: string;
-  /** The version owner. */
+  /**
+   * The version owner.
+   *
+   * @since 5.0
+   */
   ownerName?: string;
-  /** The name of the new version. */
+  /**
+   * The name of the new version.
+   *
+   * @since 5.0
+   */
   versionName: string;
 }
 
+/** @since 5.0 */
 export type VersionManagerExecutionError = "no-feature-service-found" | "no-valid-enterprise-version" | "no-valid-version-name" | "no-version-management-service-found" | undefined;
 
+/** @since 5.0 */
 export type VersionManagerLoadError = "no-feature-services" | "no-layers-property" | undefined;
 
+/** @since 5.0 */
 export type VersionManagerState = "loading" | "ready" | "executing" | "success" | "failed" | "disabled";
 
 /**
@@ -73,27 +129,69 @@ export type VersionManagerState = "loading" | "ready" | "executing" | "success"
  * await whenOnce(() => versionManager.state === "ready");
  */
 export default class VersionManager extends Accessor {
+  /** @since 5.0 */
   constructor(properties?: VersionManagerProperties);
-  /** Displays execution errors. */
+  /**
+   * Displays execution errors.
+   *
+   * @since 5.0
+   */
   get executionError(): VersionManagerExecutionError | null | undefined;
-  /** A key-value pair of [FeatureServiceResourcesBundle](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-types.html#FeatureServiceResourcesBundle). */
+  /**
+   * A key-value pair of [FeatureServiceResourcesBundle](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-types.html#FeatureServiceResourcesBundle).
+   *
+   * @since 5.0
+   */
   accessor featureServiceLookup: Map<string, FeatureServiceResourcesBundle>;
-  /** Displays an error if loading fails. */
+  /**
+   * Displays an error if loading fails.
+   *
+   * @since 5.0
+   */
   get loadError(): VersionManagerLoadError | null | undefined;
-  /** Map of Service URLs and enterprise versions. */
+  /**
+   * Map of Service URLs and enterprise versions.
+   *
+   * @since 5.0
+   */
   accessor serverVersionLookup: Map<string, number>;
-  /** Map of Service URLs and service names. Keeps track of all the [FeatureService](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html) instances in the [VersionManagementService](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html) class instance. */
+  /**
+   * Map of Service URLs and service names. Keeps track of all the [FeatureService](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html) instances in the [VersionManagementService](https://developers.arcgis.com/javascript/latest/api-reference/esri-versionManagement-VersionManagementService.html) class instance.
+   *
+   * @since 5.0
+   */
   accessor serviceNameLookup: Map<string, string>;
-  /** The current state of this object. */
+  /**
+   * The current state of this object.
+   *
+   * @since 5.0
+   */
   get state(): VersionManagerState;
-  /** Map of Service URLs and logged in users . */
+  /**
+   * Map of Service URLs and logged in users .
+   *
+   * @since 5.0
+   */
   accessor userLookup: Map<string, string>;
-  /** This property determines if a user has version admin privileges. */
+  /**
+   * This property determines if a user has version admin privileges.
+   *
+   * @since 5.0
+   */
   accessor versionAdministratorLookup: Map<string, boolean>;
-  /** This property contains metadata about the versioning state. */
+  /**
+   * This property contains metadata about the versioning state.
+   *
+   * @since 5.0
+   */
   accessor versioningStateLookup: Map<string, VersioningState>;
+  /** @since 5.0 */
   accessor versioningStates: Collection<VersioningState>;
-  /** This property defines the target [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html). */
+  /**
+   * This property defines the target [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html).
+   *
+   * @since 5.0
+   */
   accessor view: MapView;
   /**
    * The alter operation allows you to change the geodatabase version's name, description, owner, and access permissions.
@@ -106,6 +204,7 @@ export default class VersionManager extends Accessor {
    *
    * @param parameters - Parameters used to alter a version.
    * @returns When resolved, returns `true` if the alter operation completes successfully.
+   * @since 5.0
    * @example
    * await versionManager.alterVersion({
    *   featureServiceUrl: "https://myHostName.domain.com/arcgis/rest/services/TestService_11_2/FeatureServer/0",
@@ -124,6 +223,7 @@ export default class VersionManager extends Accessor {
    * @param toVersionName - Incoming version name.
    * @param toVersionGuid - Incoming version guid.
    * @returns When resolved, returns a map of version adapter to result.
+   * @since 5.0
    * @example
    * await versionManager.changeVersion(
    *    "https://myHostName.domain.com/arcgis/rest/services/TestService_11_2/FeatureServer/0",
@@ -137,6 +237,7 @@ export default class VersionManager extends Accessor {
    *
    * @param parameters - Parameters used to create a new version.
    * @returns When the promise is resolved, the VersionInfoExtendedJSON will be returned once the create operation is successfully completed.
+   * @since 5.0
    * @example
    * await versionManager.createVersion({
    *     featureServerUrl: "https://myHostName.domain.com/arcgis/rest/services/TestService_11_2/FeatureServer/0",
@@ -159,6 +260,7 @@ export default class VersionManager extends Accessor {
    * @param versionName - The name of the version that is to be deleted.
    * @param versionGuid - The guid of the version that is to be deleted.
    * @returns When resolved, returns `true` if the delete operation completes successfully.
+   * @since 5.0
    * @example
    * await versionManager.deleteVersion(
    *   "https://myHostName.domain.com/arcgis/rest/services/TestService_11_2/FeatureServer/0",
@@ -172,6 +274,7 @@ export default class VersionManager extends Accessor {
    *
    * @param featureServerUrl - The url of a feature service.
    * @returns When resolved, returns an array of `VersionInfo`.
+   * @since 5.0
    * @example const versionInfos = await versionManager.getVersionInfos("https://myHostName.domain.com/arcgis/rest/services/TestService_11_2/FeatureServer/0");
    */
   getVersionInfos(featureServerUrl: string): Promise<VersionInfo[]>;

package/versionManagement/VersioningState.d.ts

@@ -43,7 +43,7 @@ export default class VersioningState extends VersioningStateSuperclass {
   /**
    * Indicates whether the instance has loaded. When `true`,
    * the properties of the object can be accessed. A WebMap is considered loaded
-   * when its {@link versionManagement/VersioningState#layers} and {@link versionManagement/VersioningState#basemap} are created, but not
+   * when its [WebDocument2D#layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebDocument2D.html#layers) and [WebDocument2D#basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebDocument2D.html#basemap) are created, but not
    * yet loaded.
    *
    * @default false

package/versionManagement/support/jsonTypes.d.ts

@@ -1,15 +1,36 @@
 import type { AccessType } from "./type.js";
 
+/** @since 5.0 */
 export interface VersionDateInfo {
-  /** The date of the common ancestor version, which is the shared ancestor between two or more versions during the reconciliation process. */
+  /**
+   * The date of the common ancestor version, which is the shared ancestor between two or more versions during the reconciliation process.
+   *
+   * @since 5.0
+   */
   commonAncestorDate?: number;
-  /** The date when the version was last evaluated for conflicts or discrepancies during the reconciliation process. */
+  /**
+   * The date when the version was last evaluated for conflicts or discrepancies during the reconciliation process.
+   *
+   * @since 5.0
+   */
   evaluationDate?: number;
-  /** The date when the version was last modified or changed. */
+  /**
+   * The date when the version was last modified or changed.
+   *
+   * @since 5.0
+   */
   modifiedDate?: number;
-  /** The date of the most recent ancestor version, if applicable. */
+  /**
+   * The date of the most recent ancestor version, if applicable.
+   *
+   * @since 5.0
+   */
   previousAncestorDate?: number;
-  /** The date when the version was last reconciled with the parent version or the default version. */
+  /**
+   * The date when the version was last reconciled with the parent version or the default version.
+   *
+   * @since 5.0
+   */
   reconcileDate?: number;
 }
 
@@ -19,9 +40,17 @@ export interface VersionDateInfo {
  * @since 4.28
  */
 export interface VersionIdentifier {
-  /** The guid of a version. */
+  /**
+   * The guid of a version.
+   *
+   * @since 5.0
+   */
   guid: string;
-  /** The name of the version. */
+  /**
+   * The name of the version.
+   *
+   * @since 5.0
+   */
   name: string;
 }
 
@@ -31,32 +60,81 @@ export interface VersionIdentifier {
  * @since 4.28
  */
 export interface VersionInfo extends VersionDateInfo {
-  /** The access type permissions of the version. */
+  /**
+   * The access type permissions of the version.
+   *
+   * @since 5.0
+   */
   access?: AccessType;
-  /** The date the version was created on. */
+  /**
+   * The date the version was created on.
+   *
+   * @since 5.0
+   */
   creationDate?: number;
-  /** Description of the version. */
+  /**
+   * Description of the version.
+   *
+   * @since 5.0
+   */
   description?: string;
-  /** The id of the version that was edited. */
+  /**
+   * The id of the version that was edited.
+   *
+   * @since 5.0
+   */
   versionId?: string;
-  /** The identifier of a version. */
+  /**
+   * The identifier of a version.
+   *
+   * @since 5.0
+   */
   versionIdentifier: VersionIdentifier;
 }
 
+/** @since 5.0 */
 export interface VersionEditInfo {
-  /** Specifies if the version is has conflicts. */
+  /**
+   * Specifies if the version is has conflicts.
+   *
+   * @since 5.0
+   */
   hasConflicts?: boolean;
-  /** Specifies if the version has UninspectedConflicts. */
+  /**
+   * Specifies if the version has UninspectedConflicts.
+   *
+   * @since 5.0
+   */
   hasUninspectedConflicts?: boolean;
-  /** Specifies if the version is currently being edited. */
+  /**
+   * Specifies if the version is currently being edited.
+   *
+   * @since 5.0
+   */
   isBeingEdited?: boolean;
-  /** Specifies if the version is currently being read. */
+  /**
+   * Specifies if the version is currently being read.
+   *
+   * @since 5.0
+   */
   isBeingRead?: boolean;
-  /** Specifies if the version currently has a lock. */
+  /**
+   * Specifies if the version currently has a lock.
+   *
+   * @since 5.0
+   */
   isLocked?: boolean;
-  /** Specifies the date at which the version was locked. */
+  /**
+   * Specifies the date at which the version was locked.
+   *
+   * @since 5.0
+   */
   lockDate?: number;
-  /** Specifies which user is the current lock owner. */
+  /**
+   * Specifies which user is the current lock owner.
+   *
+   * @since 5.0
+   */
   lockOwner?: string;
 }
 
@@ -73,19 +151,47 @@ export interface VersionInfoExtended extends VersionInfo, VersionEditInfo {}
  * @since 4.28
  */
 export interface VersionManagementServiceCapabilities {
-  /** Indicates whether the service supports asynchronous retrieval of differences in data, allowing users to retrieve differences asynchronously. */
+  /**
+   * Indicates whether the service supports asynchronous retrieval of differences in data, allowing users to retrieve differences asynchronously.
+   *
+   * @since 5.0
+   */
   supportsAsyncDifferences: boolean;
-  /** Indicates whether the service supports asynchronous posting of edits, allowing users to post edits asynchronously. */
+  /**
+   * Indicates whether the service supports asynchronous posting of edits, allowing users to post edits asynchronously.
+   *
+   * @since 5.0
+   */
   supportsAsyncPost: boolean;
-  /** Indicates whether the service supports asynchronous reconcile operations, allowing users to reconcile conflicting edits asynchronously. */
+  /**
+   * Indicates whether the service supports asynchronous reconcile operations, allowing users to reconcile conflicting edits asynchronously.
+   *
+   * @since 5.0
+   */
   supportsAsyncReconcile: boolean;
-  /** Indicates whether the service supports conflict detection based on attribute values during editing operations. */
+  /**
+   * Indicates whether the service supports conflict detection based on attribute values during editing operations.
+   *
+   * @since 5.0
+   */
   supportsConflictDetectionByAttribute: boolean;
-  /** Indicates whether the service supports retrieving differences in data from a specific moment in time. */
+  /**
+   * Indicates whether the service supports retrieving differences in data from a specific moment in time.
+   *
+   * @since 5.0
+   */
   supportsDifferencesFromMoment: boolean;
-  /** Indicates whether the service supports retrieving differences in data between different layers or feature classes. */
+  /**
+   * Indicates whether the service supports retrieving differences in data between different layers or feature classes.
+   *
+   * @since 5.0
+   */
   supportsDifferencesWithLayers: boolean;
-  /** Indicates whether the service supports partial posting, allowing users to post only a subset of edits instead of the entire set. */
+  /**
+   * Indicates whether the service supports partial posting, allowing users to post only a subset of edits instead of the entire set.
+   *
+   * @since 5.0
+   */
   supportsPartialPost: boolean;
 }
 
@@ -95,9 +201,17 @@ export interface VersionManagementServiceCapabilities {
  * @since 4.30
  */
 export interface ServiceResult {
-  /** The error returned by the server. */
+  /**
+   * The error returned by the server.
+   *
+   * @since 5.0
+   */
   error?: ServiceError;
-  /** If true then the operation was successful. */
+  /**
+   * If true then the operation was successful.
+   *
+   * @since 5.0
+   */
   success: boolean;
 }
 
@@ -107,8 +221,16 @@ export interface ServiceResult {
  * @since 4.34
  */
 export interface ServiceError {
-  /** The error code number. */
+  /**
+   * The error code number.
+   *
+   * @since 5.0
+   */
   extendedCode: number;
-  /** The error message. */
+  /**
+   * The error message.
+   *
+   * @since 5.0
+   */
   message: string;
 }

package/versionManagement/support/type.d.ts

@@ -1,4 +1,6 @@
 
+/** @since 5.0 */
 export type AccessType = "private" | "public" | "protected" | "hidden";
 
+/** @since 5.0 */
 export type LockType = "none" | "read" | "edit";

package/versionManagement/versionAdapters/types.d.ts

@@ -8,14 +8,34 @@ import type Network from "../../networks/Network.js";
  * @since 4.30
  */
 export interface VersionAdapter {
-  /** A read only property that contains the [FeatureService](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html) url of a versionable item. */
+  /**
+   * A read only property that contains the [FeatureService](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-featureService-FeatureService.html) url of a versionable item.
+   *
+   * @since 5.0
+   */
   readonly featureServiceUrl: string;
-  /** The current gdbVersion of a versionable item. */
+  /**
+   * The current gdbVersion of a versionable item.
+   *
+   * @since 5.0
+   */
   gdbVersion?: string | null;
-  /** The current moment of a versionable item. */
+  /**
+   * The current moment of a versionable item.
+   *
+   * @since 5.0
+   */
   historicMoment?: Date | null;
-  /** The type of versionable item. */
+  /**
+   * The type of versionable item.
+   *
+   * @since 5.0
+   */
   type: "feature-layer" | "subtype-group-layer" | "network";
-  /** Contains items with the `gdbVersion` property. */
+  /**
+   * Contains items with the `gdbVersion` property.
+   *
+   * @since 5.0
+   */
   versionableItem: FeatureLayer | Network | SubtypeGroupLayer;
 }