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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arcgis/core",
-  "version": "5.0.0-next.70",
+  "version": "5.0.0-next.71",
   "homepage": "https://js.arcgis.com",
   "description": "ArcGIS Maps SDK for JavaScript: A complete 2D and 3D mapping and data visualization API",
   "keywords": [

package/popup/content/types.d.ts

@@ -4,4 +4,5 @@ import type ImageMediaInfo from "./ImageMediaInfo.js";
 import type LineChartMediaInfo from "./LineChartMediaInfo.js";
 import type PieChartMediaInfo from "./PieChartMediaInfo.js";
 
+/** @since 5.0 */
 export type PopupContentMediaInfoUnion = BarChartMediaInfo | ColumnChartMediaInfo | ImageMediaInfo | LineChartMediaInfo | PieChartMediaInfo;

package/popup/types.d.ts

@@ -2,15 +2,28 @@ import type Graphic from "../Graphic.js";
 import type Content from "./content/Content.js";
 import type Widget from "../widgets/Widget.js";
 
-/** The event that contains the [Graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) used to represent the feature. */
+/**
+ * The event that contains the [Graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) used to represent the feature.
+ *
+ * @since 5.0
+ */
 export interface PopupTemplateCreatorEvent {
-  /** The [Graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) used to represent the feature. */
+  /**
+   * The [Graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) used to represent the feature.
+   *
+   * @since 5.0
+   */
   graphic: Graphic;
 }
 
-/** Custom element content. */
+/**
+ * Custom element content.
+ *
+ * @since 5.0
+ */
 export type PopupTemplateContentCreated = string | HTMLElement | Widget | null | undefined;
 
+/** @since 5.0 */
 export type PopupTemplateContentCreatorPromise = Promise<PopupTemplateContentCreated>;
 
 /**
@@ -18,32 +31,47 @@ export type PopupTemplateContentCreatorPromise = Promise<PopupTemplateContentCre
  *
  * @param event - The event that contains the [Graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) used to represent the feature.
  * @returns The created custom content element.
+ * @since 5.0
  */
 export type PopupTemplateContentCreatorFunction = (event: PopupTemplateCreatorEvent) => PopupTemplateContentCreated | PopupTemplateContentCreatorPromise;
 
+/** @since 5.0 */
 export type PopupTemplateContentCreator = PopupTemplateContentCreatorFunction | PopupTemplateContentCreatorPromise | PopupTemplateContentCreated;
 
+/** @since 5.0 */
 export type PopupTemplateContentResolved = PopupTemplateContentCreated | Content[];
 
+/** @since 5.0 */
 export type PopupTemplateContentPromise = Promise<PopupTemplateContentResolved>;
 
-/** @param event - The event that contains the [Graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) used to represent the feature. */
+/**
+ * @param event - The event that contains the [Graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) used to represent the feature.
+ * @since 5.0
+ */
 export type PopupTemplateContentFunction = (event: PopupTemplateCreatorEvent) => PopupTemplateContentResolved | PopupTemplateContentPromise;
 
+/** @since 5.0 */
 export type PopupTemplateContent = PopupTemplateContentResolved | PopupTemplateContentPromise | PopupTemplateContentFunction;
 
+/** @since 5.0 */
 export type PopupTemplateTitleResolved = string;
 
+/** @since 5.0 */
 export type PopupTemplateTitlePromise = Promise<PopupTemplateTitleResolved>;
 
-/** @param event - The event that contains the [Graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) used to represent the feature. */
+/**
+ * @param event - The event that contains the [Graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) used to represent the feature.
+ * @since 5.0
+ */
 export type PopupTemplateTitleFunction = (event: PopupTemplateCreatorEvent) => PopupTemplateTitleResolved | PopupTemplateTitlePromise;
 
+/** @since 5.0 */
 export type PopupTemplateTitle = PopupTemplateTitleResolved | PopupTemplateTitlePromise | PopupTemplateTitleFunction;
 
 /**
  * The function that is called to destroy the custom content element.
  *
  * @param event - The event that contains the [Graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) used to represent the feature.
+ * @since 5.0
  */
 export type PopupTemplateContentDestroyer = (event: PopupTemplateCreatorEvent) => void;

package/portal/jsonTypes.d.ts

@@ -1,5 +1,6 @@
 import type SpatialReferenceClass from "../geometry/SpatialReference.js";
 
+/** @since 5.0 */
 export type Color = [
     number,
     number,
@@ -11,90 +12,206 @@ export type Color = [
     number
 ];
 
+/** @since 5.0 */
 export type LabelPosition = "curved" | "parallel";
 
+/** @since 5.0 */
 export interface FeatureTemplatePrototype {
+  /** @since 5.0 */
   attributes?: Record<string, any>;
 }
 
+/** @since 5.0 */
 export interface FeatureTemplateThumbnail {
-  /** The MIME type of the image. */
+  /**
+   * The MIME type of the image.
+   *
+   * @since 5.0
+   */
   contentType: "png" | "jpg" | "jpeg" | "image";
-  /** The height of the thumbnail. */
+  /**
+   * The height of the thumbnail.
+   *
+   * @since 5.0
+   */
   height: number;
   /**
    * The [base64EncodedImageData](https://developer.mozilla.org/en-US/docs/Web/API/WindowBase64/Base64_encoding_and_decoding)
    * presenting the thumbnail image.
+   *
+   * @since 5.0
    */
   imageData: string;
-  /** The width of the thumbnail. */
+  /**
+   * The width of the thumbnail.
+   *
+   * @since 5.0
+   */
   width: number;
 }
 
+/** @since 5.0 */
 export interface Point {
-  /** The m value of the camera position. */
+  /**
+   * The m value of the camera position.
+   *
+   * @since 5.0
+   */
   m?: number;
-  /** The spatial reference of the camera position. If not specified, the spatial reference of the video layer is used. */
+  /**
+   * The spatial reference of the camera position. If not specified, the spatial reference of the video layer is used.
+   *
+   * @since 5.0
+   */
   spatialReference?: SpatialReferenceClass | null;
-  /** The x coordinate of the anchor point, measured along the east/west axis. */
+  /**
+   * The x coordinate of the anchor point, measured along the east/west axis.
+   *
+   * @since 5.0
+   */
   x: number;
-  /** The y coordinate of the anchor point, measured along the north/south axis. */
+  /**
+   * The y coordinate of the anchor point, measured along the north/south axis.
+   *
+   * @since 5.0
+   */
   y: number;
-  /** The z coordinate of the camera position. */
+  /**
+   * The z coordinate of the camera position.
+   *
+   * @since 5.0
+   */
   z?: number;
 }
 
-/** An envelope is a rectangle defined by a range of values for each coordinate and attribute. */
+/**
+ * An envelope is a rectangle defined by a range of values for each coordinate and attribute.
+ *
+ * @since 5.0
+ */
 export interface Extent {
-  /** The maximum X value in the area of the envelope. */
+  /**
+   * The maximum X value in the area of the envelope.
+   *
+   * @since 5.0
+   */
   xmax: number;
-  /** The minimum X value in the area of the envelope. */
+  /**
+   * The minimum X value in the area of the envelope.
+   *
+   * @since 5.0
+   */
   xmin: number;
-  /** The maximum Y value in the area of the envelope. */
+  /**
+   * The maximum Y value in the area of the envelope.
+   *
+   * @since 5.0
+   */
   ymax: number;
-  /** The minimum Y value in the area of the envelope. */
+  /**
+   * The minimum Y value in the area of the envelope.
+   *
+   * @since 5.0
+   */
   ymin: number;
 }
 
 /**
  * The **VideoServiceLayerInfo** defines layer information for video layers published within the same
  * video service.
+ *
+ * @since 5.0
  */
 export interface VideoServiceLayerInfo {
-  /** The layer id of the video layer. */
+  /**
+   * The layer id of the video layer.
+   *
+   * @since 5.0
+   */
   layerId: number;
-  /** The URL to the poster image for the video layer. */
+  /**
+   * The URL to the poster image for the video layer.
+   *
+   * @since 5.0
+   */
   posterUrl: string;
-  /** The source type of the video layer. */
+  /**
+   * The source type of the video layer.
+   *
+   * @since 5.0
+   */
   sourceType: VideoSourceType;
-  /** The title of the video layer. */
+  /**
+   * The title of the video layer.
+   *
+   * @since 5.0
+   */
   title: string;
-  /** The layer type. The type is always "Video Layer" for VideoLayers. */
+  /**
+   * The layer type. The type is always "Video Layer" for VideoLayers.
+   *
+   * @since 5.0
+   */
   type: "Video Layer";
 }
 
+/** @since 5.0 */
 export type VideoSourceType = "ondemand" | "livestream";
 
+/** @since 5.0 */
 export interface VideoGroundControlPoint {
-  /** The latitude. */
+  /**
+   * The latitude.
+   *
+   * @since 5.0
+   */
   lat: number;
-  /** The longitude. */
+  /**
+   * The longitude.
+   *
+   * @since 5.0
+   */
   lon: number;
-  /** The x coordinate in pixels. */
+  /**
+   * The x coordinate in pixels.
+   *
+   * @since 5.0
+   */
   x: number;
-  /** The y coordinate in pixels. */
+  /**
+   * The y coordinate in pixels.
+   *
+   * @since 5.0
+   */
   y: number;
 }
 
+/** @since 5.0 */
 export type VideoQuality = "sd" | "hd" | "fhd" | "qhd" | "uhd";
 
-/** The **Codecs** is an object that represents the codecs used by the video layer. */
+/**
+ * The **Codecs** is an object that represents the codecs used by the video layer.
+ *
+ * @since 5.0
+ */
 export interface Codecs {
-  /** The audio codec used in the video layer. */
+  /**
+   * The audio codec used in the video layer.
+   *
+   * @since 5.0
+   */
   audio: string;
-  /** The text codec used in the video layer. */
+  /**
+   * The text codec used in the video layer.
+   *
+   * @since 5.0
+   */
   text: string;
-  /** The video codec used in the video layer. */
+  /**
+   * The video codec used in the video layer.
+   *
+   * @since 5.0
+   */
   video: string;
 }
 
@@ -104,19 +221,47 @@ export interface Codecs {
  * @since 4.34
  */
 export interface VideoCameraInfo {
-  /** The far distance of the camera in meters. */
+  /**
+   * The far distance of the camera in meters.
+   *
+   * @since 5.0
+   */
   farDistance: number;
-  /** The field of view of the camera in degrees. */
+  /**
+   * The field of view of the camera in degrees.
+   *
+   * @since 5.0
+   */
   fov: number;
-  /** The heading of the camera in degrees. */
+  /**
+   * The heading of the camera in degrees.
+   *
+   * @since 5.0
+   */
   heading: number;
-  /** The height of the camera in meters. */
+  /**
+   * The height of the camera in meters.
+   *
+   * @since 5.0
+   */
   height: number;
-  /** The near distance of the camera in meters. */
+  /**
+   * The near distance of the camera in meters.
+   *
+   * @since 5.0
+   */
   nearDistance: number;
-  /** The position of the camera. */
+  /**
+   * The position of the camera.
+   *
+   * @since 5.0
+   */
   position: Point;
-  /** The tilt of the camera in degrees. */
+  /**
+   * The tilt of the camera in degrees.
+   *
+   * @since 5.0
+   */
   tilt: number;
 }
 
@@ -125,64 +270,111 @@ export interface VideoCameraInfo {
  * [sendMessageToClient()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html#sendMessageToClient) method.
  * It is an esri Feature JSON object as defined in the
  * [Feature object specification](https://next.gha.arcgis.com/documentation/common-data-types/feature-object.htm).
+ *
+ * @since 5.0
  */
 export interface Feature {
-  /** Name-value pairs of fields and field values associated with the received data. */
+  /**
+   * Name-value pairs of fields and field values associated with the received data.
+   *
+   * @since 5.0
+   */
   attributes: Record<string, any>;
   /**
    * A location of the received data containing x, y coordinates for points, paths for lines, and rings for polygons, along with
    * the spatial reference wkid.
+   *
+   * @since 5.0
    */
   geometry?: object | null;
 }
 
+/** @since 5.0 */
 export type GeometryType = "esriGeometryPoint" | "esriGeometryPolyline" | "esriGeometryPolygon" | "esriGeometryEnvelope" | "esriGeometryMultiPatch" | "esriGeometryMultipoint";
 
+/** @since 5.0 */
 export interface SimpleTransformation {
-  /** the spatial reference well known id */
+  /**
+   * the spatial reference well known id
+   *
+   * @since 5.0
+   */
   wkid: number;
 }
 
+/** @since 5.0 */
 export interface CompositeTransformation {
+  /** @since 5.0 */
   geoTransforms: GeoTransform[];
 }
 
+/** @since 5.0 */
 export interface GeoTransform {
-  /** indicates whether to transform forward or not. */
+  /**
+   * indicates whether to transform forward or not.
+   *
+   * @since 5.0
+   */
   transformForward: boolean;
-  /** the spatial reference well known id. */
+  /**
+   * the spatial reference well known id.
+   *
+   * @since 5.0
+   */
   wkid: number;
 }
 
+/** @since 5.0 */
 export type DatumTransformation = number | SimpleTransformation | CompositeTransformation;
 
+/** @since 5.0 */
 export type SQLFormat = "none" | "native" | "standard";
 
+/** @since 5.0 */
 export interface Progressor {
-  /** Progress message. */
+  /**
+   * Progress message.
+   *
+   * @since 5.0
+   */
   message: string;
-  /** Progress percentage. */
+  /**
+   * Progress percentage.
+   *
+   * @since 5.0
+   */
   percent?: number;
 }
 
+/** @since 5.0 */
 export type FormElementType = "field" | "attachment" | "group" | "relationship" | "text" | "utilityNetworkAssociations";
 
+/** @since 5.0 */
 export type TimeResolution = "minutes" | "seconds";
 
+/** @since 5.0 */
 export type TimeResolutionMS = TimeResolution | "milliseconds";
 
+/** @since 5.0 */
 export type InputMethod = "any" | "capture" | "upload";
 
+/** @since 5.0 */
 export type FormAttachmentAssociationType = "any" | "exact" | "exactOrNone";
 
+/** @since 5.0 */
 export type GroupState = "collapsed" | "expanded";
 
+/** @since 5.0 */
 export type TextFormatType = "plain-text" | "markdown";
 
+/** @since 5.0 */
 export type FormExpressionReturnType = "boolean" | "date" | "number" | "string";
 
+/** @since 5.0 */
 export type TableElementType = "group" | "field" | "attachment" | "relationship";
 
+/** @since 5.0 */
 export type LayoutType = "basic-grid" | "chronological-mono-timeline" | "chronological-multi-timeline" | "geographic-organic-standard" | "hierarchical-bottom-to-top" | "hierarchical-top-to-bottom" | "organic-community" | "organic-fusiform" | "organic-leaf-circle" | "organic-standard" | "radial-node-centric" | "radial-root-centric" | "tree-bottom-to-top" | "tree-left-to-right" | "tree-right-to-left" | "tree-top-to-bottom";
 
+/** @since 5.0 */
 export type TimeDirection = "bottom" | "left" | "right" | "top";

package/portal/support/resourceUtils.d.ts

@@ -1,18 +1,24 @@
 import type { PortalItemResourceWithPath } from "../types.js";
 
-/** Parameters used when fetching portal item resources using [PortalItem.fetchResources()](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#fetchResources). */
+/**
+ * Parameters used when fetching portal item resources using [PortalItem.fetchResources()](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#fetchResources).
+ *
+ * @since 5.0
+ */
 export interface FetchResourcesParameters {
   /**
    * The maximum number of results to be included in the [FetchResourcesResult.resources](#FetchResourcesResult) set response. The maximum value allowed is
    *   `100`. The `start` property combined with the `num` property can be used to paginate the search results.
    *
    * @default 10
+   * @since 5.0
    */
   num?: number;
   /**
    * A field to sort the results.
    *
    * @default resource
+   * @since 5.0
    */
   sortField?: "created" | "size" | "resource";
   /**
@@ -23,6 +29,7 @@ export interface FetchResourcesParameters {
    *   desc | Sort the results in descending order.
    *
    * @default asc
+   * @since 5.0
    */
   sortOrder?: "asc" | "desc";
   /**
@@ -30,26 +37,59 @@ export interface FetchResourcesParameters {
    *   `start`property, along with the `num` property can be used to paginate the search results.
    *
    * @default 1
+   * @since 5.0
    */
   start?: number;
 }
 
-/** Object returned when [PortalItem.fetchResources()](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#fetchResources) promise resolves. */
+/**
+ * Object returned when [PortalItem.fetchResources()](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#fetchResources) promise resolves.
+ *
+ * @since 5.0
+ */
 export interface FetchResourcesResult {
-  /** The next entry index if the current result set doesn't contain all results. */
+  /**
+   * The next entry index if the current result set doesn't contain all results.
+   *
+   * @since 5.0
+   */
   nextStart: number;
-  /** The fetched resources. */
+  /**
+   * The fetched resources.
+   *
+   * @since 5.0
+   */
   resources: FetchResource[];
-  /** The total number of results. */
+  /**
+   * The total number of results.
+   *
+   * @since 5.0
+   */
   total: number;
 }
 
-/** A resource reference returned in the result of [PortalItem.fetchResources()](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#fetchResources). */
+/**
+ * A resource reference returned in the result of [PortalItem.fetchResources()](https://developers.arcgis.com/javascript/latest/api-reference/esri-portal-PortalItem.html#fetchResources).
+ *
+ * @since 5.0
+ */
 export interface FetchResource {
-  /** When the resource was created. */
+  /**
+   * When the resource was created.
+   *
+   * @since 5.0
+   */
   created: Date;
-  /** Relative path of the resource. */
+  /**
+   * Relative path of the resource.
+   *
+   * @since 5.0
+   */
   resource: PortalItemResourceWithPath;
-  /** The size of the resource in bytes. */
+  /**
+   * The size of the resource in bytes.
+   *
+   * @since 5.0
+   */
   size: number;
 }