@arcgis/coding-components 5.2.0-next.16 → 5.2.0-next.18

package/dist/components/types.d.ts

@@ -39,7 +39,23 @@ export interface EditorProfileDefinition {
 }
 
 /** @deprecated since 5.1. Use EditorProfileDefinition instead. */
-export interface IEditorProfileDefinition extends EditorProfileDefinition {}
+export interface IEditorProfileDefinition {
+  /** Optional label for the profile. Used in the editor when displaying the variables panel. */
+  label?: string;
+  /**
+   * The collection of variables that will be passed to the expression at execution time.
+   * The variable declarations are used to help the editor provide validation and completion.
+   */
+  variables: ProfileVariable[];
+  /** The version of the Arcade API that the editor should use during validation and completion. */
+  apiVersion?: string;
+  /** The Arcade API bundles that the editor should use during validation and completion. */
+  bundles?: BundleType[];
+  /** A collection of additional Arcade API items that will be provided at runtime. */
+  additionalApiItems?: ApiItem[];
+  /** A collection of api item names to hide. */
+  hiddenApiItems?: string[];
+}
 
 export interface PredefinedProfile {
   /** The well known profile ID. */
@@ -53,7 +69,16 @@ export interface PredefinedProfile {
 }
 
 /** @deprecated since 5.1. Use PredefinedProfile instead. */
-export interface IPredefinedProfile extends PredefinedProfile {}
+export interface IPredefinedProfile {
+  /** The well known profile ID. */
+  id: ProfileId;
+  /** The variables that should be disabled for the profile. */
+  disabledVariables?: string[];
+  /** Provides the definitions for the definition based variables (feature, featureSet, featureSetCollection). */
+  definitions: VariableDefinitions;
+  /** A collection of api item names to hide. */
+  hiddenApiItems?: string[];
+}
 
 /** The type of value variables supported. */
 export type ProfileVariableValueType = "boolean" | "date" | "dateOnly" | "geometry" | "knowledgeGraph" | "number" | "text" | "time";
@@ -77,7 +102,12 @@ export interface ProfileVariableBase {
 }
 
 /** @deprecated since 5.1. Use ProfileVariableBase instead. */
-export interface IProfileVariableBase extends ProfileVariableBase {}
+export interface IProfileVariableBase {
+  /** Name of the variable */
+  name: string;
+  /** Description for the variable */
+  description?: string;
+}
 
 /** Single value profile variable declaration. */
 export interface ProfileValue extends ProfileVariableBase {
@@ -85,7 +115,9 @@ export interface ProfileValue extends ProfileVariableBase {
 }
 
 /** @deprecated since 5.1. Use ProfileValue instead. */
-export interface IProfileValue extends ProfileValue {}
+export interface IProfileValue extends IProfileVariableBase {
+  readonly type: ProfileVariableValueType;
+}
 
 /** Dictionary profile variable declaration. Properties of a dictionary are profile variables. */
 export interface ProfileDictionary extends ProfileVariableBase {
@@ -95,7 +127,11 @@ export interface ProfileDictionary extends ProfileVariableBase {
 }
 
 /** @deprecated since 5.1. Use ProfileDictionary instead. */
-export interface IProfileDictionary extends ProfileDictionary {}
+export interface IProfileDictionary extends IProfileVariableBase {
+  readonly type: "dictionary";
+  /** The dictionary properties. Properties are variables as well. */
+  properties?: ProfileVariable[];
+}
 
 /** Dictionary profile variable declaration. Properties of a dictionary are profile variables. */
 export interface ProfileArray extends ProfileVariableBase {
@@ -105,7 +141,11 @@ export interface ProfileArray extends ProfileVariableBase {
 }
 
 /** @deprecated since 5.1. Use ProfileArray instead. */
-export interface IProfileArray extends ProfileArray {}
+export interface IProfileArray extends IProfileVariableBase {
+  readonly type: "array";
+  /** The type for the array elements. */
+  elementType?: ProfileVariable;
+}
 
 /**
  * Feature profile variable declaration.
@@ -119,7 +159,11 @@ export interface ProfileFeature extends ProfileVariableBase {
 }
 
 /** @deprecated since 5.1. Use ProfileFeature instead. */
-export interface IProfileFeature extends ProfileFeature {}
+export interface IProfileFeature extends IProfileVariableBase {
+  readonly type: "feature";
+  /** Describes how the editor will find the definition for the feature. */
+  definition?: FeatureDefinition;
+}
 
 /**
  * FeatureSet profile variable declaration.
@@ -133,7 +177,11 @@ export interface ProfileFeatureSet extends ProfileVariableBase {
 }
 
 /** @deprecated since 5.1. Use ProfileFeatureSet instead. */
-export interface IProfileFeatureSet extends ProfileFeatureSet {}
+export interface IProfileFeatureSet extends IProfileVariableBase {
+  readonly type: "featureSet";
+  /** Describes how the editor will find the definition for the feature set. */
+  definition?: FeatureSetDefinition;
+}
 
 /**
  * FeatureSetCollection profile variable declaration.
@@ -147,7 +195,11 @@ export interface ProfileFeatureSetCollection extends ProfileVariableBase {
 }
 
 /** @deprecated since 5.1. Use ProfileFeatureSetCollection instead. */
-export interface IProfileFeatureSetCollection extends ProfileFeatureSetCollection {}
+export interface IProfileFeatureSetCollection extends IProfileVariableBase {
+  readonly type: "featureSetCollection";
+  /** Describes how the featureSetCollection will find its definition. */
+  definition?: FeatureSetCollectionDefinition;
+}
 
 /** Voxel profile variable declaration. */
 export interface ProfileVoxel extends ProfileVariableBase {
@@ -157,7 +209,11 @@ export interface ProfileVoxel extends ProfileVariableBase {
 }
 
 /** @deprecated since 5.1. Use ProfileVoxel instead. */
-export interface IProfileVoxel extends ProfileVoxel {}
+export interface IProfileVoxel extends IProfileVariableBase {
+  readonly type: "voxel";
+  /** Describes how the editor will find the definition for the voxel. */
+  definition?: VoxelDefinition;
+}
 
 /** Pixel profile variable declaration. */
 export interface ProfilePixel extends ProfileVariableBase {
@@ -167,12 +223,16 @@ export interface ProfilePixel extends ProfileVariableBase {
 }
 
 /** @deprecated since 5.1. Use ProfilePixel instead. */
-export interface IProfilePixel extends ProfilePixel {}
+export interface IProfilePixel extends IProfileVariableBase {
+  readonly type: "pixel";
+  /** Describes how the editor will find the definition for the pixel. */
+  definition?: PixelDefinition;
+}
 
 export type FeatureLikeProfile = ProfileFeature | ProfilePixel | ProfileVoxel;
 
 /** @deprecated since 5.1. Use FeatureLikeProfile instead. */
-export type IFeatureLikeProfile = FeatureLikeProfile;
+export type IFeatureLikeProfile = IProfileFeature | IProfilePixel | IProfileVoxel;
 
 /**
  * Data catalog datastore profile variable declaration.
@@ -275,7 +335,12 @@ export interface PortalItemProperties {
 }
 
 /** @deprecated since 5.1. Use PortalItemProperties instead. */
-export interface IPortalItemProperties extends PortalItemProperties {}
+export interface IPortalItemProperties {
+  /** The unique portal item id. */
+  id: string;
+  /** The optional portal url. Default: www.arcgis.com. */
+  portal?: { url: string; };
+}
 
 /** WebMap and Service FeatureSetCollection can be defined by a portal item. */
 export interface PortalItemDefinition {
@@ -284,7 +349,10 @@ export interface PortalItemDefinition {
 }
 
 /** @deprecated since 5.1. Use PortalItemDefinition instead. */
-export interface IPortalItemDefinition extends PortalItemDefinition {}
+export interface IPortalItemDefinition {
+  /** Describes a portal item. */
+  portalItem: PortalItemProperties;
+}
 
 /** FeatureLayer can be defined from a Feature Layer portal item. */
 export interface FeatureLayerItemDefinition extends PortalItemDefinition {
@@ -293,7 +361,10 @@ export interface FeatureLayerItemDefinition extends PortalItemDefinition {
 }
 
 /** @deprecated since 5.1. Use FeatureLayerItemDefinition instead. */
-export interface IFeatureLayerItemDefinition extends FeatureLayerItemDefinition {}
+export interface IFeatureLayerItemDefinition extends IPortalItemDefinition {
+  /** The layer id in the feature layer portal item. Default to 0. */
+  layerId?: number;
+}
 
 /** FeatureLayers and GroupLayers can be created by providing the url to the resource in a feature service. */
 export interface UrlDefinition {
@@ -302,7 +373,10 @@ export interface UrlDefinition {
 }
 
 /** @deprecated since 5.1. Use UrlDefinition instead. */
-export interface IUrlDefinition extends UrlDefinition {}
+export interface IUrlDefinition {
+  /** The url of the resource. */
+  url?: string | null;
+}
 
 /** The most basic way to define a feature or feature set is by passing a collection of fields */
 export type FieldsDefinition = Pick<FeatureLayer, "fields">;
@@ -350,7 +424,9 @@ export interface ExtendedPredefinedProfile extends PredefinedProfile {
 }
 
 /** @deprecated since 5.1. Use ExtendedPredefinedProfile instead. */
-export interface IExtendedPredefinedProfile extends ExtendedPredefinedProfile {}
+export interface IExtendedPredefinedProfile extends IPredefinedProfile {
+  additionalVariables?: ProfileVariable[];
+}
 
 export interface EditorCodeSuggestionGroup {
   /** Label for the suggestion group */
@@ -360,7 +436,12 @@ export interface EditorCodeSuggestionGroup {
 }
 
 /** @deprecated since 5.1. Use EditorCodeSuggestionGroup instead. */
-export interface IEditorCodeSuggestionGroup extends EditorCodeSuggestionGroup {}
+export interface IEditorCodeSuggestionGroup {
+  /** Label for the suggestion group */
+  label: string;
+  /** List of suggestions for the group */
+  suggestions: EditorCodeSuggestion[];
+}
 
 export interface EditorCodeSuggestion {
   /** A short label for the suggestion. Can be thought as a title */
@@ -374,7 +455,16 @@ export interface EditorCodeSuggestion {
 }
 
 /** @deprecated since 5.1. Use EditorCodeSuggestion instead. */
-export interface IEditorCodeSuggestion extends EditorCodeSuggestion {}
+export interface IEditorCodeSuggestion {
+  /** A short label for the suggestion. Can be thought as a title */
+  label: string;
+  /** A short description that will be showed below the label in the list of suggestions panel */
+  description?: string;
+  /** Markdown string that will be rendered along with the code in the detail panel */
+  documentation?: string;
+  /** The code for the suggestion. Will be injected in the editor is selected */
+  code: string;
+}
 
 export type SidePanelName = "api" | "none" | "suggestions" | "variables";
 
@@ -394,7 +484,20 @@ export interface ContextReferences {
 }
 
 /** @deprecated since 5.1. Use ContextReferences instead. */
-export interface IContextReferences extends ContextReferences {}
+export interface IContextReferences {
+  /**
+   * Spatial reference object used to define the spatial reference for the arcade runtime.
+   * By defaults, the spatial reference is set to Web Mercator (wkid: 3857).
+   */
+  spatialReference?: SpatialReference | { wkid: number; } | null;
+  /**
+   * Defines the default time zone in which to create and display Arcade date types.
+   * By default, the time zone is set to "system".
+   */
+  timeZone?: string;
+  /** Defines the "services" passed to the arcade executor. */
+  services?: ArcadeServices;
+}
 
 /**
  * If a profile doesn't contain a map, the spatial reference of geometries will be defaulted to
@@ -410,4 +513,10 @@ export interface EditorTestContext extends ContextReferences {
 }
 
 /** @deprecated since 5.1. Use EditorTestContext instead. */
-export interface IEditorTestContext extends EditorTestContext {}
+export interface IEditorTestContext extends IContextReferences {
+  /**
+   * An object of key/value pairs where the key is the name of a profile variable.
+   * The key's value must be of type ArcGIS core ProfileVariableInstance.
+   */
+  profileVariableInstances: ProfileVariableInstances;
+}