@arcgis/core 5.0.0-next.130 → 5.0.0-next.131

package/applications/KnowledgeStudio/generalSharedKgUtils.d.ts

@@ -6,7 +6,7 @@
  * To the maximum extent possible, ArcGIS Knowledge Studio should use the same public interface as
  * PS/3rd part developers.
  *
- * @experimental
+ * @internal
  * @internal
  */
 import type WebLinkChart from "../../WebLinkChart.js";
@@ -21,65 +21,65 @@ import type { RequestOptions } from "../../request/types.js";
 
 /**
  * @param extent
- * @experimental
+ * @internal
  * @internal
  */
 export function extentToInBoundsRings(extent: Extent): number[][][];
 
 /**
- * @experimental
+ * @internal
  * @internal
  */
 export interface BindParametersFromCypherQueryResult {
-  /** @experimental */
+  /** @internal */
   bindParameters: string[];
-  /** @experimental */
+  /** @internal */
   parseErrors: RecognizerError[] | null;
 }
 
 /**
- * @experimental
+ * @internal
  * @internal
  */
 export interface RecognizerError {
-  /** @experimental */
+  /** @internal */
   line: number;
-  /** @experimental */
+  /** @internal */
   column: number;
-  /** @experimental */
+  /** @internal */
   msg: string;
-  /** @experimental */
+  /** @internal */
   e?: any;
 }
 
 /**
  * @param query
- * @experimental
+ * @internal
  * @internal
  */
 export function getBindParametersFromCypherQuery(query: string): Promise<BindParametersFromCypherQueryResult>;
 
 /**
  * @param properties
- * @experimental
+ * @internal
  * @internal
  */
 export function newLinkChartLayerWithOptimizedGeometry(properties?: LinkChartLayerWithOptimizedGeometryProperties): LinkChartLayer;
 
 /**
- * @experimental
+ * @internal
  * @internal
  */
 export type LinkChartLayerWithOptimizedGeometryProperties = Omit<LinkChartLayerProperties, "initializationInclusionModeDefinition">
   & {
-  /** @experimental */
+  /** @internal */
   initializationInclusionModeDefinition?: InclusionModeDefinitionOptimizedGeometry;
 };
 
 /**
  * Defines the sublayer structure and the named types that will be in the KnowledgeGraphLayer
  *
- * @experimental
+ * @internal
  * @internal
  */
 export interface InclusionModeDefinitionOptimizedGeometry {
@@ -88,20 +88,20 @@ export interface InclusionModeDefinitionOptimizedGeometry {
    * regardless of whether or not they are included in the `namedTypeDefinition`. If `true` all named types ([EntityType](https://developers.arcgis.com/javascript/latest/references/core/rest/knowledgeGraph/EntityType/) and
    * [RelationshipType](https://developers.arcgis.com/javascript/latest/references/core/rest/knowledgeGraph/RelationshipType/)) will be added as an empty sublayer.
    *
-   * @experimental
+   * @internal
    */
   generateAllSublayers: boolean;
   /**
    * A map of named types and the specific instances
    * of those types to include in the layer.
    *
-   * @experimental
+   * @internal
    */
   namedTypeDefinitions: Map<string, LayerInclusionDefinition>;
 }
 
 /**
- * @experimental
+ * @internal
  * @internal
  */
 export interface LayerInclusionDefinition {
@@ -109,14 +109,14 @@ export interface LayerInclusionDefinition {
    * 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
+   * @internal
    */
   useAllData: boolean;
   /**
    * A map of the specific members of the named type to be included.
    * The key is the global ID of the instance.
    *
-   * @experimental
+   * @internal
    */
   members?: Map<string, LayerInclusionMemberDefinition>;
 }
@@ -124,20 +124,20 @@ export interface LayerInclusionDefinition {
 /**
  * Defines the list of `members` for a named type in the [InclusionModeDefinitionOptimizedGeometry](https://developers.arcgis.com/javascript/latest/references/core/applications/KnowledgeStudio/generalSharedKgUtils/#InclusionModeDefinitionOptimizedGeometry).
  *
- * @experimental
+ * @internal
  * @internal
  */
 export interface LayerInclusionMemberDefinition {
   /**
    * The global ID of the specific instance of the named type to be included in the layer.
    *
-   * @experimental
+   * @internal
    */
   id: string;
   /**
    * The exact point location of the entity on the LinkChart.
    *
-   * @experimental
+   * @internal
    */
   linkChartLocation?: Point | OptimizedGeometry;
 }
@@ -145,13 +145,13 @@ export interface LayerInclusionMemberDefinition {
 /**
  * An alternative geometry format for serialized geometries
  *
- * @experimental
+ * @internal
  * @internal
  */
 export interface OptimizedGeometry {
-  /** @experimental */
+  /** @internal */
   lengths: number[];
-  /** @experimental */
+  /** @internal */
   coords: number[];
 }
 
@@ -159,7 +159,7 @@ export interface OptimizedGeometry {
  * @param graphType
  * @param graphTypeName
  * @param displayLabelProperty
- * @experimental
+ * @internal
  * @internal
  */
 export function getDefaultLinkChartSublayerLabelingInfos(graphType: "entity" | "relationship", graphTypeName: string, displayLabelProperty: string): LabelClass[] | null | undefined;
@@ -168,7 +168,7 @@ export function getDefaultLinkChartSublayerLabelingInfos(graphType: "entity" | "
  * @param graphTypeName
  * @param geometryType
  * @param displayLabelProperty
- * @experimental
+ * @internal
  * @internal
  */
 export function getDefaultKnowledgeSublayerLabelingInfos(graphTypeName: string, geometryType: "point" | "multipoint" | "polyline" | "polygon" | null | undefined, displayLabelProperty: string): LabelClass[] | null | undefined;
@@ -180,20 +180,20 @@ 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
  * @internal
  */
 export function studioGetRelationshipEndNodeIds(records: IdTypePair[], kg: KnowledgeGraph, options?: StudioGetRelationshipEndNodeIdsOptions): Promise<IdTypePair[]>;
 
 /**
- * @experimental
+ * @internal
  * @internal
  */
 export interface StudioGetRelationshipEndNodeIdsOptions {
   /**
    * Additional [options](https://developers.arcgis.com/javascript/latest/references/core/request/types/#RequestOptions) to be used for the data request.
    *
-   * @experimental
+   * @internal
    */
   requestOptions?: RequestOptions;
 }
@@ -205,7 +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
  * @internal
  */
 export function studioGetRelationshipEndNodeMap(records: IdTypePair[], kg: KnowledgeGraph, options?: StudioGetRelationshipEndNodeMapOptions): Promise<Map<string, [
@@ -214,14 +214,14 @@ export function studioGetRelationshipEndNodeMap(records: IdTypePair[], kg: Knowl
 ]>>;
 
 /**
- * @experimental
+ * @internal
  * @internal
  */
 export interface StudioGetRelationshipEndNodeMapOptions {
   /**
    * Additional [options](https://developers.arcgis.com/javascript/latest/references/core/request/types/#RequestOptions) to be used for the data request.
    *
-   * @experimental
+   * @internal
    */
   requestOptions?: RequestOptions;
 }
@@ -230,7 +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
  * @internal
  */
 export function webLinkChartFromJSON(json: any): WebLinkChart;

package/applications/KnowledgeStudio/layerInternalAccessUtils.d.ts

@@ -6,7 +6,7 @@
  * To the maximum extent possible, ArcGIS Knowledge Studio should use the same public interface as
  * PS/3rd part developers.
  *
- * @experimental
+ * @internal
  * @internal
  */
 import type KnowledgeGraphLayer from "../../layers/KnowledgeGraphLayer.js";
@@ -17,7 +17,7 @@ import type { OriginName } from "../../core/accessorSupport/types.js";
 
 /**
  * @param layer - The layer to get the inclusion definition from.
- * @experimental
+ * @internal
  * @since 4.32
  * @internal
  */
@@ -25,7 +25,7 @@ export function getInclusionDefinitionFromLayer(layer: KnowledgeGraphLayer | Lin
 
 /**
  * @param layer - The layer to get the inclusion definition from.
- * @experimental
+ * @internal
  * @since 4.32
  * @internal
  */
@@ -34,7 +34,7 @@ export function removeInclusionDefinitionFromLayer(layer: KnowledgeGraphLayer):
 /**
  * @param layer - The layer to add the inclusion definition to.
  * @param inclusionDefinition - The inclusion definition to add to the layer.
- * @experimental
+ * @internal
  * @internal
  */
 export function addInclusionDefinitionToLayer(layer: KnowledgeGraphLayer, inclusionDefinition: InclusionModeDefinitionOptimizedGeometry): void;
@@ -43,14 +43,14 @@ export function addInclusionDefinitionToLayer(layer: KnowledgeGraphLayer, inclus
  * @param layer - The layer to read the JSON onto itself
  * @param json
  * @param originName
- * @experimental
+ * @internal
  * @internal
  */
 export function readKnowledgeLayerJSON(layer: KnowledgeGraphLayer | LinkChartLayer | KnowledgeGraphSublayer, json: any, originName: OriginName): void;
 
 /**
  * @param sublayer - The sublayer to convert to JSON.
- * @experimental
+ * @internal
  * @internal
  */
 export function kgSublayerToJSON(sublayer: KnowledgeGraphSublayer): any;
@@ -58,20 +58,20 @@ export function kgSublayerToJSON(sublayer: KnowledgeGraphSublayer): any;
 /**
  * @param sublayer - The sublayer to get the origin ID from.
  * @param propertyName - The property name to get the origin ID for.
- * @experimental
+ * @internal
  * @internal
  */
 export function originIdOfPropertyOnSublayer(sublayer: KnowledgeGraphSublayer, propertyName: string): OriginId;
 
 /**
- * @experimental
+ * @internal
  * @internal
  */
 export type OriginId = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
 
 /**
  * @param sublayer - The sublayer to get the privileges from.
- * @experimental
+ * @internal
  * @internal
  */
 export function getKgSublayerPrivileges(sublayer: KnowledgeGraphSublayer): {

package/applications/KnowledgeStudio/reshape.d.ts

@@ -1,7 +1,7 @@
 /**
  * A utility method for getting a Reshape instance with support for connected reshaping.
  *
- * @experimental
+ * @internal
  * @internal
  */
 import type Graphic from "../../Graphic.js";
@@ -18,38 +18,38 @@ import type LinkChartView from "../../views/LinkChartView.js";
 import type { ResourceHandle } from "../../core/Handles.js";
 
 /**
- * @experimental
+ * @internal
  * @internal
  */
 export interface ReshapeInterface {
   /**
    * An array of `ConnectedReshapeProviderFactory` objects that provide connected reshape functionality for the reshape operation.
    *
-   * @experimental
+   * @internal
    */
   connectedReshapeProviders?: ConnectedReshapeProviderFactory[] | null;
   /**
    * The graphic being reshaped.
    *
-   * @experimental
+   * @internal
    */
   graphic: Graphic;
   /**
    * A GraphicsLayer to be used for temporary graphics during the reshape operation.
    *
-   * @experimental
+   * @internal
    */
   layer: GraphicsLayer;
   /**
    * The MapView in which the reshape operation is taking place.
    *
-   * @experimental
+   * @internal
    */
   view: MapView;
   /**
    * Destroys the reshape instance.
    *
-   * @experimental
+   * @internal
    */
   destroy: () => void;
 }
@@ -58,13 +58,13 @@ export interface ReshapeInterface {
  * Returns a reshape operation.
  *
  * @param properties - The constructor properties.
- * @experimental
+ * @internal
  * @internal
  */
 export function getReshape(properties: ReshapeProperties): Promise<ReshapeInterface>;
 
 /**
- * @experimental
+ * @internal
  * @internal
  */
 export type ReshapeProperties = Pick<ReshapeInterface, "connectedReshapeProviders" | "graphic" | "layer" | "view">;
@@ -76,19 +76,19 @@ export type ReshapeProperties = Pick<ReshapeInterface, "connectedReshapeProvider
  * @param targetEntityType - The type of the entity to be moved.
  * @param targetView - The LinkChartView in which the node movement reshape operation will take place.
  * @param options - Optional parameters.
- * @experimental
+ * @internal
  * @internal
  */
 export function studioStartNodeMovement(targetEntityId: string, targetEntityType: string, targetView: LinkChartView, options?: { useSnappingGrid?: boolean; }): Promise<StudioNodeMovementReturnType>;
 
 /**
- * @experimental
+ * @internal
  * @internal
  */
 export interface StudioNodeMovementReturnType {
-  /** @experimental */
+  /** @internal */
   commitNodeMovement: () => Promise<Point>;
-  /** @experimental */
+  /** @internal */
   cancelNodeMovement: () => void;
 }
 
@@ -97,64 +97,64 @@ export interface StudioNodeMovementReturnType {
  *
  * @param targetView - The LinkChartView in which the node movement reshape operation is taking place.
  * @param movementStopCallback - The callback function to be called when the node movement stops.
- * @experimental
+ * @internal
  * @internal
  */
 export function onNodeMovementStop(targetView: LinkChartView, movementStopCallback: MovementStopCallback): ResourceHandle;
 
 /**
  * @param event - The event object containing information about the node movement.
- * @experimental
+ * @internal
  * @internal
  */
 export type MovementStopCallback = (event: MovementStopCallbackEvent) => void;
 
 /**
- * @experimental
+ * @internal
  * @internal
  */
 export interface MovementStopCallbackEvent {
   /**
    * The graphic representing the node being moved.
    *
-   * @experimental
+   * @internal
    */
   mover: Graphic;
   /**
    * The change in the x-coordinate of the node's position.
    *
-   * @experimental
+   * @internal
    */
   dx: number;
   /**
    * The change in the y-coordinate of the node's position.
    *
-   * @experimental
+   * @internal
    */
   dy: number;
 }
 
 /**
- * @experimental
+ * @internal
  * @internal
  */
 export type ConnectedReshapeSupportedLayer = GeoJSONLayer | FeatureLayer | OrientedImageryLayer | SceneLayer | SubtypeSublayer | GraphicsLayer | KnowledgeGraphSublayer;
 
 /**
- * @experimental
+ * @internal
  * @internal
  */
 export interface ReshapeFeature {
   /**
    * The graphic being reshaped.
    *
-   * @experimental
+   * @internal
    */
   graphic: Graphic;
   /**
    * The layer to which the graphic belongs.
    *
-   * @experimental
+   * @internal
    */
   layer: ConnectedReshapeSupportedLayer;
 }
@@ -162,32 +162,32 @@ export interface ReshapeFeature {
 /**
  * Represents a feature that has been modified by a ConnectedReshapeProvider due to being connected (or otherwise spatially related to) the feature(s) or vertex(es) being reshaped.
  *
- * @experimental
+ * @internal
  * @internal
  */
 export interface ModifiedFeature {
   /**
    * The current version of the feature, with a geometry that reflects whatever translation/transformation has been made as a result of the reshape operation
    *
-   * @experimental
+   * @internal
    */
   graphic: Graphic;
   /**
    * The layer to which the feature belongs
    *
-   * @experimental
+   * @internal
    */
   layer: ConnectedReshapeSupportedLayer;
   /**
    * The original version of the feature, before the start of the reshape operation
    *
-   * @experimental
+   * @internal
    */
   originalGraphic: Graphic;
   /**
    * Some unique identifier of the feature. E.g., the feature's object ID.
    *
-   * @experimental
+   * @internal
    */
   uniqueId: string | number;
 }
@@ -195,20 +195,20 @@ export interface ModifiedFeature {
 /**
  * An object that provides "connected reshaping" functionality for a feature or vertex being reshaped. This object is given information about each incremental position change throughout the reshape operation. The object is responsible for identifying and loading features that are connected to the primary feature, and providing, for each incremental change, the current positions of those connected features.
  *
- * @experimental
+ * @internal
  * @internal
  */
 export interface ConnectedReshapeProvider {
   /**
    * Not used at this time. Hard-code this to `false` for now.
    *
-   * @experimental
+   * @internal
    */
   updating: boolean;
   /**
    * Called each time the position of the given feature or vertex changes during the reshape operation. This function should return an array of [ModifiedFeature](https://developers.arcgis.com/javascript/latest/references/core/applications/KnowledgeStudio/reshape/#ModifiedFeature) objects representing the current positions of the connected features given the change so far to the position of the feature or vertex being reshaped. Parameters represent the incremental change in position of the feature (or vertex) since the last time `translate` was called. Values are in the units of the spatial reference.
    *
-   * @experimental
+   * @internal
    */
   translate: TranslateMethod;
 }
@@ -220,45 +220,45 @@ export interface ConnectedReshapeProvider {
  * @param deltaY - The change in the y-coordinate of the feature or vertex being reshaped, in the units of the spatial reference.
  * @param deltaZ - The change in the z-coordinate of the feature or vertex being reshaped, in the units of the spatial reference. This may be `nil` if the feature does not have a z-coordinate.
  * @returns An array of modified features representing the current positions of the connected features given the change so far to the position of the feature or vertex being reshaped.
- * @experimental
+ * @internal
  * @internal
  */
 export type TranslateMethod = (deltaX: number, deltaY: number, deltaZ: number | null | undefined) => ModifiedFeature[];
 
 /**
- * @experimental
+ * @internal
  * @internal
  */
 export interface VertexInfo {
   /**
    * The index of the ring or path in the feature's geometry that contains the vertex.
    *
-   * @experimental
+   * @internal
    */
   pathIndex: number;
   /**
    * The index of the vertex in the ring or path.
    *
-   * @experimental
+   * @internal
    */
   vertexIndex: number;
 }
 
 /**
- * @experimental
+ * @internal
  * @internal
  */
 export interface ConnectedReshapeProviderFactory {
   /**
    * Called at the start a reshape operation involving one or more whole features. Should return a `ConnectedReshapeProvider` that will provide information about features connected to this feature(s) during the reshape operation.
    *
-   * @experimental
+   * @internal
    */
   getFeatureReshapeProvider: GetFeatureReshapeProvider;
   /**
    * Called at the start of a reshape operation involving one or more vertices of a feature. Should return a `ConnectedReshapeProvider` that will provide information about features connected to this vertex(es) during the reshape operation.
    *
-   * @experimental
+   * @internal
    */
   getVertexReshapeProvider: GetVertexReshapeProvider;
 }
@@ -266,7 +266,7 @@ export interface ConnectedReshapeProviderFactory {
 /**
  * @param features - The features being reshaped.
  * @returns The connected reshape provider for the features.
- * @experimental
+ * @internal
  * @internal
  */
 export type GetFeatureReshapeProvider = (features: ReshapeFeature[]) => ConnectedReshapeProvider | null | undefined;
@@ -275,7 +275,7 @@ export type GetFeatureReshapeProvider = (features: ReshapeFeature[]) => Connecte
  * @param feature - The feature being reshaped.
  * @param vertices - The vertices of the feature being reshaped.
  * @returns The connected reshape provider for the feature.
- * @experimental
+ * @internal
  * @internal
  */
 export type GetVertexReshapeProvider = (feature: ReshapeFeature, vertices: VertexInfo[]) => ConnectedReshapeProvider | null | undefined;

package/applications/KnowledgeStudio/resourceSerializationUtils.d.ts

@@ -1,5 +1,5 @@
 /**
- * @experimental
+ * @internal
  * @since 4.32
  * @internal
  */
@@ -8,20 +8,20 @@ import type { InclusionModeDefinitionOptimizedGeometry } from "./generalSharedKg
 import type { AbortOptions } from "../../core/promiseUtils.js";
 
 /**
- * @experimental
+ * @internal
  * @internal
  */
 export interface SerializedResourceURLs {
-  /** @experimental */
+  /** @internal */
   entitiesUrl?: string | null;
-  /** @experimental */
+  /** @internal */
   relationshipsUrl?: string | null;
 }
 
 /**
  * @param serializedResourceURLs
  * @param options
- * @experimental
+ * @internal
  * @internal
  */
 export function fetchAndConvertSerializedLinkChart(serializedResourceURLs: SerializedResourceURLs, options?: AbortOptions): Promise<InclusionModeDefinitionOptimizedGeometry>;
@@ -30,19 +30,19 @@ export function fetchAndConvertSerializedLinkChart(serializedResourceURLs: Seria
  * @param idCollectionsUrl
  * @param generateAllSublayers
  * @param options
- * @experimental
+ * @internal
  * @internal
  */
 export function fetchAndConvertSerializedKnowledgeIdMap(idCollectionsUrl: string, generateAllSublayers?: boolean, options?: AbortOptions): Promise<InclusionModeDefinitionOptimizedGeometry>;
 
 /**
- * @experimental
+ * @internal
  * @internal
  */
 export interface SerializedFeatureCollections {
-  /** @experimental */
+  /** @internal */
   entitiesFC: Uint8Array<ArrayBuffer>;
-  /** @experimental */
+  /** @internal */
   relationshipsFC: Uint8Array<ArrayBuffer>;
 }
 
@@ -50,7 +50,7 @@ export interface SerializedFeatureCollections {
  * @param inclusionDefinition
  * @param kg
  * @param endpointMap
- * @experimental
+ * @internal
  * @internal
  */
 export function serializeInclusionDefinitionToAllPbf(inclusionDefinition: InclusionModeDefinitionOptimizedGeometry, kg: KnowledgeGraph, endpointMap: Map<string, [
@@ -60,7 +60,7 @@ export function serializeInclusionDefinitionToAllPbf(inclusionDefinition: Inclus
 
 /**
  * @param inclusionDefinition
- * @experimental
+ * @internal
  * @internal
  */
 export function serializeInclusionDefinitionToIdCollectionsMapPbf(inclusionDefinition: InclusionModeDefinitionOptimizedGeometry): Promise<Uint8Array<ArrayBuffer>>;