@arcgis/core 5.0.0-next.66 → 5.0.0-next.68

package/applications/Components/reactiveUtils.d.ts

@@ -2,71 +2,75 @@
  * Utilities related to reactivity that we're not quite ready to expose in the public API but which are useful for
  * internal component development.
  *
+ * @experimental
  * @internal
  */
 
 /**
- * @deprecated
+ * @experimental
  * @internal
  */
 export interface Signal<T> {
   value: T;
   /**
-   * @deprecated
    * @param mutateFn
+   * @experimental
    */
   mutate(mutateFn: (value: T) => void): void;
 }
 
 /**
- * @deprecated
+ * @experimental
  * @internal
  */
 export interface ReactiveObservable {
+  /** @experimental */
   notify(): void;
 }
 
 /**
- * @deprecated
+ * @experimental
  * @internal
  */
 export interface ReactiveTrackingTarget {
+  /** @experimental */
   clear(): void;
+  /** @experimental */
   destroy(): void;
 }
 
 /**
- * @deprecated
  * @param initialValue
  * @param equalityFunction
+ * @experimental
  * @internal
  */
 export function signal<T>(initialValue: T, equalityFunction?: (a: T, b: T) => boolean): Signal<T>;
 
 /**
- * @deprecated
+ * @experimental
  * @internal
  */
 export function createObservable(): ReactiveObservable;
 
 /**
- * @deprecated
  * @param notify
+ * @experimental
  * @internal
  */
 export function createTrackingTarget(notify: () => void): ReactiveTrackingTarget;
 
 /**
- * @deprecated
  * @param observable
+ * @experimental
  * @internal
  */
 export function trackAccess(observable: ReactiveObservable): void;
 
 /**
- * @deprecated
  * @param target
  * @param callback
+ * @experimental
  * @internal
  */
 export function runTracked<T>(target: ReactiveTrackingTarget, callback: () => T): T | null;

package/applications/Components/sanitizerUtils.d.ts

@@ -1,12 +1,14 @@
 /**
  * Sanitiziing utils for Components.
  *
+ * @experimental
  * @internal
  */
 
 /**
  * The rendering sanitizer for use in Components.
  *
+ * @experimental
  * @internal
  */
 export const renderingSanitizer: any;

package/applications/Components/stringUtils.d.ts

@@ -1,6 +1,7 @@
 /**
  * String utils for Components.
  *
+ * @experimental
  * @internal
  */
 
@@ -10,6 +11,7 @@
  * @param regExpString - The input string to escape.
  * @param except - Special characters to be left unescaped.
  * @returns A string with special characters escaped, except for those specified in `except`.
+ * @experimental
  * @internal
  */
 export function escapeRegExpString(regExpString: string, except?: string): string;
@@ -22,6 +24,7 @@ export function escapeRegExpString(regExpString: string, except?: string): strin
  * @param map - Either a data object to lookup for the key's value
  *                              or a function that will be called with the input key.
  * @returns A string with the keys replaced.
+ * @experimental
  * @internal
  */
 export function replace(template: string, map: object | ((substring: string) => string) | null | undefined): string;
@@ -31,6 +34,7 @@ export function replace(template: string, map: object | ((substring: string) =>
  *
  * @param html - The HTML source code from which to remove tags.
  * @returns A string in which all HTML tags have been removed.
+ * @experimental
  * @internal
  */
 export function stripHTML(html: string): string;
@@ -41,6 +45,7 @@ export function stripHTML(html: string): string;
  * @param template - The template string containing the potential key.
  * @param key - The key string to look for in the template.
  * @returns A boolean indicating whether or not the key is contained in the template.
+ * @experimental
  * @internal
  */
 export function templateHasKey(template: string, key: string): boolean;

package/applications/Components/styleUtils.d.ts

@@ -1,6 +1,7 @@
 /**
  * Style utils for Components.
  *
+ * @experimental
  * @internal
  */
 
@@ -9,6 +10,7 @@
  *
  * @param item
  * @param type
+ * @experimental
  * @internal
  */
 export function symbolUrlFromStyleItem(item: object, type: string): string | null | undefined;

package/applications/Components/svgUtils.d.ts

@@ -1,6 +1,7 @@
 /**
  * SVG utils for Components.
  *
+ * @experimental
  * @internal
  */
 
@@ -8,6 +9,7 @@
  * Calculates and returns the bounding box for a given shape.
  *
  * @param shape
+ * @experimental
  * @internal
  */
 export function getBoundingBox(shape: any): any;
@@ -16,6 +18,7 @@ export function getBoundingBox(shape: any): any;
  * Computes and returns the bounding box that encompasses all given bounding boxes.
  *
  * @param bboxes
+ * @experimental
  * @internal
  */
 export function computeBBox(bboxes: any[]): any | null | undefined;
@@ -32,6 +35,7 @@ export function computeBBox(bboxes: any[]): any | null | undefined;
  * @param useRotationSize
  * @param offset
  * @param bloomSize
+ * @experimental
  * @internal
  */
 export function getTransformMatrix(bbox: any, width: number, height: number, overallStrokeWidth: number, scale: boolean, rotation: number | null | undefined, useRotationSize: boolean, offset?: [

package/applications/Components/testUtils.d.ts

@@ -1,6 +1,7 @@
 /**
  * View utils for components
  *
+ * @experimental
  * @internal
  */
 import type { MapViewOrSceneView } from "../../views/MapViewOrSceneView.js";
@@ -9,6 +10,7 @@ import type { MapViewOrSceneView } from "../../views/MapViewOrSceneView.js";
  * Waits until the specified view is not updating anymore.
  *
  * @param view
+ * @experimental
  * @internal
  */
 export function waitUpdated(view: MapViewOrSceneView): Promise<void>;
@@ -16,6 +18,7 @@ export function waitUpdated(view: MapViewOrSceneView): Promise<void>;
 /**
  * Gets all the service mock dependencies.
  *
+ * @experimental
  * @internal
  */
 export function getServiceMockDependencies(): Promise<any>;

package/applications/Components/viewUtils.d.ts

@@ -1,6 +1,7 @@
 /**
  * View utils for components
  *
+ * @experimental
  * @internal
  */
 import type { MapViewOrSceneView } from "../../views/MapViewOrSceneView.js";
@@ -9,6 +10,7 @@ import type { MapViewOrSceneView } from "../../views/MapViewOrSceneView.js";
  * Waits until the specified view is not updating anymore.
  *
  * @param view
+ * @experimental
  * @internal
  */
 export function waitUpdated(view: MapViewOrSceneView): Promise<void>;

package/applications/Components/webStyleSymbolUtils.d.ts

@@ -1,6 +1,7 @@
 /**
  * Web Style Symbol utils for Components.
  *
+ * @experimental
  * @internal
  */
 import type { AbortOptions } from "../../core/promiseUtils.js";
@@ -19,6 +20,7 @@ import type { Symbol2D3DUnion } from "../../symbols/types.js";
  * @param type
  * @param symbolUrlFromStyleItem
  * @param options
+ * @experimental
  * @internal
  */
 export function fetchSymbolFromStyle(styleResponse: any, symbolName: string, context: object, type: string, symbolUrlFromStyleItem: (...args: any[]) => string | null | undefined, options?: AbortOptions | null | undefined): Promise<Symbol2D3DUnion>;

package/applications/Excalibur/videoViewUtils.d.ts

@@ -1,6 +1,7 @@
 /**
  * VideoView utilities for the Excalibur application.
  *
+ * @experimental
  * @internal
  */
 import type VideoLayer from "../../layers/VideoLayer.js";
@@ -11,6 +12,7 @@ import type VideoView from "../../views/VideoView.js";
  *
  * @param properties - The properties for the VideoView constructor.
  * @returns A new VideoView instance.
+ * @experimental
  * @internal
  */
 export function createVideoView(properties: VideoViewProperties): InternalVideoView;
@@ -18,21 +20,35 @@ export function createVideoView(properties: VideoViewProperties): InternalVideoV
 /**
  * VideoViewParams
  *
+ * @experimental
  * @internal
  */
 export interface VideoViewProperties {
-  /** The `id` or node representing the DOM element containing the view. */
+  /**
+   * The `id` or node representing the DOM element containing the view.
+   *
+   * @experimental
+   */
   container?: HTMLDivElement | null;
-  /** The VideoLayer. */
+  /**
+   * The VideoLayer.
+   *
+   * @experimental
+   */
   layer?: VideoLayer | null;
 }
 
 /**
  * VideoView
  *
+ * @experimental
  * @internal
  */
 export interface InternalVideoView extends VideoView {
-  /** Determines if the operational data overlay is visible */
+  /**
+   * Determines if the operational data overlay is visible
+   *
+   * @experimental
+   */
   operationalDataVisible: boolean;
 }

package/applications/ExperienceBuilder/sketchUtils.d.ts

@@ -1,6 +1,7 @@
 /**
  * Sketch utilities for the experience builder application.
  *
+ * @experimental
  * @internal
  */
 import type Sketch from "../../widgets/Sketch.js";
@@ -13,6 +14,7 @@ import type { CustomActionProps, CustomToolOptions } from "../../widgets/Sketch/
  * @param createToolOptions - Options for the custom tools.
  * @param customActionOptions - Options for the custom tools.
  * @returns The passed in sketch widget.
+ * @experimental
  * @internal
  */
 export function setCustomTools(sketch: Sketch, createToolOptions?: CustomToolOptions[] | null, customActionOptions?: CustomActionProps[] | null): Sketch;
@@ -21,6 +23,7 @@ export function setCustomTools(sketch: Sketch, createToolOptions?: CustomToolOpt
  * Closes the settings popover, if it is open.
  *
  * @param sketch - Reference to the sketch widget to configure.
+ * @experimental
  * @since 4.32
  * @internal
  */
@@ -32,12 +35,16 @@ export function dismissFloatingElements(sketch: Sketch): void;
  * @param sketch - Reference to the sketch widget to configure.
  * @param location - Selection tool location.
  * @returns The passed in sketch widget.
+ * @experimental
  * @since 4.32
  * @internal
  */
 export function setContextualToolLocation(sketch: Sketch, location: "inline" | "inline-end" | "separate"): Sketch;
 
-/** @internal */
+/**
+ * @experimental
+ * @internal
+ */
 export type SketchGroupName = "selectionTools" | "selectionSet" | "createTools" | "undoRedo" | "settings";
 
 /**
@@ -49,6 +56,7 @@ export type SketchGroupName = "selectionTools" | "selectionSet" | "createTools"
  * @param sketch - Reference to the sketch widget to configure.
  * @param priorities - Group priorities.
  * @returns The passed in sketch widget.
+ * @experimental
  * @since 4.32
  * @internal
  */
@@ -62,6 +70,7 @@ export function setGroupCollapsePriorities(sketch: Sketch, priorities: Map<Sketc
  * @param sketch - Reference to the sketch widget to configure.
  * @param options - Group collapse options.
  * @returns The passed in sketch widget.
+ * @experimental
  * @since 4.33
  * @internal
  */

package/applications/KnowledgeStudio/dataModelVisualization.d.ts

@@ -6,6 +6,7 @@
  * To the maximum extent possible, ArcGIS Knowledge Studio should use the same public interface as
  * PS/3rd part developers.
  *
+ * @experimental
  * @internal
  */
 import type { DataModelViewProperties, DataModelViewReturnType } from "../../layers/knowledgeGraph/dataModelVisualizationUtils.js";
@@ -13,6 +14,7 @@ import type { DataModelViewProperties, DataModelViewReturnType } from "../../lay
 /**
  * @param properties - The options object for the datamodel view.
  * @returns An object with load and destroy functions for the data model view.
+ * @experimental
  * @internal
  */
 export function getDataModelView(properties: DataModelViewProperties): DataModelViewReturnType;

package/applications/KnowledgeStudio/generalSdkInternalAccess.d.ts

@@ -6,6 +6,7 @@
  * To the maximum extent possible, ArcGIS Knowledge Studio should use the same public interface as
  * PS/3rd party developers.
  *
+ * @experimental
  * @internal
  */
 import type Graphic from "../../Graphic.js";
@@ -16,38 +17,64 @@ import type LinkChartView from "../../views/LinkChartView.js";
 import type MapView from "../../views/MapView.js";
 import type { Evented } from "../../core/Evented.js";
 
-/** @internal */
+/**
+ * @experimental
+ * @internal
+ */
 export interface TypedSelectionToolbarViewModel extends Evented {
+  /** @experimental */
   "@eventTypes": TypedSelectionToolbarViewModelEvents;
+  /** @experimental */
   activate: TypedSelectionToolbarViewModelActivate;
+  /** @experimental */
   cancel: () => void;
+  /** @experimental */
   destroy: () => void;
+  /** @experimental */
   sources?: Array<FeatureLayer | KnowledgeGraphLayer | LinkChartLayer> | null;
 }
 
 /**
  * @param parameters - The selection operation parameters.
+ * @experimental
  * @internal
  */
 export type TypedSelectionToolbarViewModelActivate = (parameters: SelectionOperationParameters) => void;
 
-/** @internal */
+/**
+ * @experimental
+ * @internal
+ */
 export interface SelectionOperationParameters {
+  /** @experimental */
   createTool: "point" | "polygon" | "circle" | "rectangle";
+  /** @experimental */
   mode: "freehand" | "click";
+  /** @experimental */
   selectOnComplete?: boolean;
+  /** @experimental */
   type?: "add" | "remove" | "replace";
 }
 
-/** @internal */
+/**
+ * @experimental
+ * @internal
+ */
 export interface TypedSelectionToolbarViewModelEvents {
+  /** @experimental */
   complete: TypedSelectionToolbarViewModelSelectionResultType;
 }
 
-/** @internal */
+/**
+ * @experimental
+ * @internal
+ */
 export interface TypedSelectionToolbarViewModelSelectionResultType {
+  /** @experimental */
   aborted: boolean;
+  /** @experimental */
   operationType: "add" | "remove" | "replace";
+  /** @experimental */
   selection: Graphic[];
 }
 
@@ -55,12 +82,14 @@ export interface TypedSelectionToolbarViewModelSelectionResultType {
  * @param view - The MapView instance.
  * @param sources - An array of layers to be used as sources for selection.
  * @returns A new instance of SelectionToolbarViewModel.
+ * @experimental
  * @internal
  */
 export function getNewTypedSelectionToolbarViewModel(view: MapView | LinkChartView, sources?: Array<FeatureLayer | KnowledgeGraphLayer | LinkChartLayer>): TypedSelectionToolbarViewModel;
 
 /**
  * @param domains - An array of domain strings to be registered as no-CORS domains.
+ * @experimental
  * @internal
  */
 export function typedRegisterNoCorsDomain(domains: string[]): void;

package/applications/KnowledgeStudio/generalSharedKgUtils.d.ts

@@ -6,6 +6,7 @@
  * To the maximum extent possible, ArcGIS Knowledge Studio should use the same public interface as
  * PS/3rd part developers.
  *
+ * @experimental
  * @internal
  */
 import type WebLinkChart from "../../WebLinkChart.js";
@@ -20,45 +21,65 @@ import type { RequestOptions } from "../../request/types.js";
 
 /**
  * @param extent
+ * @experimental
  * @internal
  */
 export function extentToInBoundsRings(extent: Extent): number[][][];
 
-/** @internal */
+/**
+ * @experimental
+ * @internal
+ */
 export interface BindParametersFromCypherQueryResult {
+  /** @experimental */
   bindParameters: string[];
+  /** @experimental */
   parseErrors: RecognizerError[] | null;
 }
 
-/** @internal */
+/**
+ * @experimental
+ * @internal
+ */
 export interface RecognizerError {
+  /** @experimental */
   column: number;
+  /** @experimental */
   e?: any;
+  /** @experimental */
   line: number;
+  /** @experimental */
   msg: string;
 }
 
 /**
  * @param query
+ * @experimental
  * @internal
  */
 export function getBindParametersFromCypherQuery(query: string): Promise<BindParametersFromCypherQueryResult>;
 
 /**
  * @param properties
+ * @experimental
  * @internal
  */
 export function newLinkChartLayerWithOptimizedGeometry(properties?: LinkChartLayerWithOptimizedGeometryProperties): LinkChartLayer;
 
-/** @internal */
+/**
+ * @experimental
+ * @internal
+ */
 export type LinkChartLayerWithOptimizedGeometryProperties = Omit<LinkChartLayerProperties, "initializationInclusionModeDefinition">
   & {
+  /** @experimental */
   initializationInclusionModeDefinition?: InclusionListDefinition;
 };
 
 /**
  * Defines the sublayer structure and the named types that will be in the KnowledgeGraphLayer
  *
+ * @experimental
  * @internal
  */
 export interface InclusionListDefinition {
@@ -66,25 +87,36 @@ export interface InclusionListDefinition {
    * Specifies whether to create sublayers for each [named type](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-GraphNamedObject.html)
    * regardless of whether or not they are included in the `namedTypeDefinition`. If `true` all named types ([EntityType](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-EntityType.html) and
    * [RelationshipType](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-knowledgeGraph-RelationshipType.html)) will be added as an empty sublayer.
+   *
+   * @experimental
    */
   generateAllSublayers: boolean;
   /**
    * A map of named types and the specific instances
    * of those types to include in the layer.
+   *
+   * @experimental
    */
   namedTypeDefinitions: Map<string, LayerInclusionDefinition>;
 }
 
-/** @internal */
+/**
+ * @experimental
+ * @internal
+ */
 export interface LayerInclusionDefinition {
   /**
    * A map of the specific members of the named type to be included.
    * The key is the global ID of the instance.
+   *
+   * @experimental
    */
   members?: Map<string, LayerInclusionMemberDefinition>;
   /**
    * If `true` all of the instances of the named type will be included regardless of if there is a defined list of members.
    * If `false` only the instances specified in the `members` property will be included.
+   *
+   * @experimental
    */
   useAllData: boolean;
 }
@@ -92,22 +124,34 @@ export interface LayerInclusionDefinition {
 /**
  * Defines the list of `members` for a named type in the {@link applications/KnowledgeStudio/generalSharedKgUtils#inclusionModeDefinition}.
  *
+ * @experimental
  * @internal
  */
 export interface LayerInclusionMemberDefinition {
-  /** The global ID of the specific instance of the named type to be included in the layer. */
+  /**
+   * The global ID of the specific instance of the named type to be included in the layer.
+   *
+   * @experimental
+   */
   id: string;
-  /** The exact point location of the entity on the LinkChart. */
+  /**
+   * The exact point location of the entity on the LinkChart.
+   *
+   * @experimental
+   */
   linkChartLocation?: Point | OptimizedGeometry;
 }
 
 /**
  * An alternative geometry format for serialized geometries
  *
+ * @experimental
  * @internal
  */
 export interface OptimizedGeometry {
+  /** @experimental */
   coords: number[];
+  /** @experimental */
   lengths: number[];
 }
 
@@ -115,6 +159,7 @@ export interface OptimizedGeometry {
  * @param graphType
  * @param graphTypeName
  * @param displayLabelProperty
+ * @experimental
  * @internal
  */
 export function getDefaultLinkChartSublayerLabelingInfos(graphType: "entity" | "relationship", graphTypeName: string, displayLabelProperty: string): LabelClass[] | null | undefined;
@@ -123,6 +168,7 @@ export function getDefaultLinkChartSublayerLabelingInfos(graphType: "entity" | "
  * @param graphTypeName
  * @param geometryType
  * @param displayLabelProperty
+ * @experimental
  * @internal
  */
 export function getDefaultKnowledgeSublayerLabelingInfos(graphTypeName: string, geometryType: "point" | "multipoint" | "polyline" | "polygon" | null | undefined, displayLabelProperty: string): LabelClass[] | null | undefined;
@@ -134,13 +180,21 @@ export function getDefaultKnowledgeSublayerLabelingInfos(graphTypeName: string,
  * @param kg - The knowledge graph service that contains the relationships.
  * @param options
  * @returns Returns the origin and destination entity and named types for each relationship.
+ * @experimental
  * @internal
  */
 export function studioGetRelationshipEndNodeIds(records: IdTypePair[], kg: KnowledgeGraph, options?: StudioGetRelationshipEndNodeIdsOptions): Promise<IdTypePair[]>;
 
-/** @internal */
+/**
+ * @experimental
+ * @internal
+ */
 export interface StudioGetRelationshipEndNodeIdsOptions {
-  /** Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request-types.html#RequestOptions) to be used for the data request. */
+  /**
+   * Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request-types.html#RequestOptions) to be used for the data request.
+   *
+   * @experimental
+   */
   requestOptions?: RequestOptions;
 }
 
@@ -151,6 +205,7 @@ export interface StudioGetRelationshipEndNodeIdsOptions {
  * @param kg - The knowledge graph containing the relationships.
  * @param options
  * @returns Returns the relationship id, and the origin and destination ids.
+ * @experimental
  * @internal
  */
 export function studioGetRelationshipEndNodeMap(records: IdTypePair[], kg: KnowledgeGraph, options?: StudioGetRelationshipEndNodeMapOptions): Promise<Map<string, [
@@ -158,9 +213,16 @@ export function studioGetRelationshipEndNodeMap(records: IdTypePair[], kg: Knowl
     string
 ]>>;
 
-/** @internal */
+/**
+ * @experimental
+ * @internal
+ */
 export interface StudioGetRelationshipEndNodeMapOptions {
-  /** Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request-types.html#RequestOptions) to be used for the data request. */
+  /**
+   * Additional [options](https://developers.arcgis.com/javascript/latest/api-reference/esri-request-types.html#RequestOptions) to be used for the data request.
+   *
+   * @experimental
+   */
   requestOptions?: RequestOptions;
 }
 
@@ -168,6 +230,7 @@ export interface StudioGetRelationshipEndNodeMapOptions {
  * Returns a map of origin and destination entities for  specific relationships.
  *
  * @param json - The JSON representation of a WebLinkChart.
+ * @experimental
  * @internal
  */
 export function webLinkChartFromJSON(json: any): WebLinkChart;