@arcgis/coding-components 4.29.0-beta.47 → 4.29.0-beta.49

package/dist/types/utils/profile/editor-profile.d.ts

@@ -1,7 +1,7 @@
 import { ApiVariableType, ApiProfile, ProfileStrings } from "@arcgis/arcade-languageservice";
 import type { FeatureDefinition, FeatureSetDefinition, IEditorProfileDefinition, IFieldsDefinition, IProfileArray, IProfileDictionary, IProfileFeature, IProfileFeatureSet, IProfileFeatureSetCollection, IProfileValue, IProfileVariable, IProfileVariableBase, ProfileVariableValueType, SupportedLayer } from "./types";
 type IIntlProfileStrings = ProfileStrings & {
-  [key: string]: string;
+    [key: string]: string;
 };
 type SupportedSource = SupportedLayer | __esri.FeatureSet | IFieldsDefinition;
 /**
@@ -9,50 +9,50 @@ type SupportedSource = SupportedLayer | __esri.FeatureSet | IFieldsDefinition;
  * or Feature Services.
  */
 interface IFeatureSetCollections {
-  /**
-   * The collection of layers in the featureSetCollection. Layers contain features
-   * with geometry.
-   */
-  layers: Array<FeatureSetVariable | GroupOfVariables>;
-  /**
-   * The collection of tables in the featureSetCollection. Tables contain features
-   * that don't have a geometry.
-   */
-  tables: Array<FeatureSetVariable | GroupOfVariables>;
-  /**
-   * If the feature set collection represents a Web Map then it will contain the
-   * WebMap instance.
-   * If the feature set collection represents a service then it will be its URL.
-   */
-  source: __esri.WebMap | string;
+    /**
+     * The collection of layers in the featureSetCollection. Layers contain features
+     * with geometry.
+     */
+    layers: Array<FeatureSetVariable | GroupOfVariables>;
+    /**
+     * The collection of tables in the featureSetCollection. Tables contain features
+     * that don't have a geometry.
+     */
+    tables: Array<FeatureSetVariable | GroupOfVariables>;
+    /**
+     * If the feature set collection represents a Web Map then it will contain the
+     * WebMap instance.
+     * If the feature set collection represents a service then it will be its URL.
+     */
+    source: __esri.WebMap | string;
 }
 /**
  * Represents a string that will have to be manufactured from a Intl strings resource.
  */
 interface IIntlString {
-  /**
-   * The intl code in the Intl strings resource.
-   */
-  code: string;
-  /**
-   * The properties that the Intl string may leverage during the composition of the string.
-   * Example:
-   * - the intl string is defined as: "webmaptitle": "Web Map - {title}"
-   * - the formatValues should be an object `{title: "California Fires"}`
-   */
-  formatValues?: Record<string, string>;
+    /**
+     * The intl code in the Intl strings resource.
+     */
+    code: string;
+    /**
+     * The properties that the Intl string may leverage during the composition of the string.
+     * Example:
+     * - the intl string is defined as: "webmaptitle": "Web Map - {title}"
+     * - the formatValues should be an object `{title: "California Fires"}`
+     */
+    formatValues?: Record<string, string>;
 }
 type ProfileItemType = ApiVariableType | "group";
 export type EditorVariable = ValueVariable | FeatureVariable | FeatureSetVariable | FeatureSetCollectionVariable | DictionaryVariable | ArrayVariable;
 interface ConstructorProperties<T> {
-  profile?: EditorProfile | null;
-  declaration?: Partial<T>;
-  label?: string | IIntlString;
-  description?: string | IIntlString;
-  snippet?: string;
-  nonInteractive?: boolean;
-  filterDescription?: boolean;
-  icon?: string;
+    profile?: EditorProfile | null;
+    declaration?: Partial<T>;
+    label?: string | IIntlString;
+    description?: string | IIntlString;
+    snippet?: string;
+    nonInteractive?: boolean;
+    filterDescription?: boolean;
+    icon?: string;
 }
 /**
  * Represents a item in the EditorProfile. The profile is converted into an optimized way for
@@ -60,69 +60,69 @@ interface ConstructorProperties<T> {
  * structures are created such as groups.
  */
 declare abstract class ProfileItemBase {
-  protected _profile: EditorProfile | null | undefined;
-  private readonly _label;
-  protected readonly description?: string | IIntlString | undefined;
-  abstract readonly type: ProfileItemType;
-  protected filterDescription: boolean;
-  /**
-   * True if the item repsents a collection of items.
-   */
-  abstract readonly isCollection: boolean;
-  constructor(_profile: EditorProfile | null | undefined, _label: string | IIntlString | undefined, description?: string | IIntlString | undefined);
-  /**
-   * Returns the label string.
-   */
-  getLabel(): string;
-  /**
-   * Returns the description string.
-   */
-  getDescription(): string;
-  /**
-   * Returns true if the item pass the filter test
-   */
-  passFilter(filterExpression?: RegExp): boolean;
+    protected _profile: EditorProfile | null | undefined;
+    private readonly _label;
+    protected readonly description?: string | IIntlString | undefined;
+    abstract readonly type: ProfileItemType;
+    protected filterDescription: boolean;
+    /**
+     * True if the item repsents a collection of items.
+     */
+    abstract readonly isCollection: boolean;
+    constructor(_profile: EditorProfile | null | undefined, _label: string | IIntlString | undefined, description?: string | IIntlString | undefined);
+    /**
+     * Returns the label string.
+     */
+    getLabel(): string;
+    /**
+     * Returns the description string.
+     */
+    getDescription(): string;
+    /**
+     * Returns true if the item pass the filter test
+     */
+    passFilter(filterExpression?: RegExp): boolean;
 }
 /**
  * The base class for profile variables representation in the EditorProfile.
  */
 declare abstract class VariableBase extends ProfileItemBase {
-  abstract readonly type: ApiVariableType;
-  readonly name: string;
-  readonly snippet: string;
-  /**
-   * True if the variable doesn't can be used as snippet by the editor.
-   */
-  readonly nonInteractive: boolean;
-  protected declaration: Partial<IProfileVariableBase>;
-  icon: string | undefined;
-  constructor(props: ConstructorProperties<IProfileVariableBase>);
-  /**
-   * Returns the IProfileVariable json representation.
-   */
-  abstract toProfileVariableDefinition(): IProfileVariable;
+    abstract readonly type: ApiVariableType;
+    readonly name: string;
+    readonly snippet: string;
+    /**
+     * True if the variable doesn't can be used as snippet by the editor.
+     */
+    readonly nonInteractive: boolean;
+    protected declaration: Partial<IProfileVariableBase>;
+    icon: string | undefined;
+    constructor(props: ConstructorProperties<IProfileVariableBase>);
+    /**
+     * Returns the IProfileVariable json representation.
+     */
+    abstract toProfileVariableDefinition(): IProfileVariable;
 }
 /**
  * Represents the IProfileValue.
  */
 export declare class ValueVariable extends VariableBase {
-  type: ProfileVariableValueType;
-  isCollection: false;
-  constructor(props: ConstructorProperties<IProfileValue>);
-  getDescription(): string;
-  toProfileVariableDefinition(): IProfileVariable;
+    type: ProfileVariableValueType;
+    isCollection: false;
+    constructor(props: ConstructorProperties<IProfileValue>);
+    getDescription(): string;
+    toProfileVariableDefinition(): IProfileVariable;
 }
 /**
  * Represents the IProfileArray. The main difference is that the IProfileValue type
  * is used as valueType.
  */
 export declare class ArrayVariable extends VariableBase {
-  type: "array";
-  isCollection: false;
-  elementType: IProfileVariable;
-  constructor(props: ConstructorProperties<IProfileArray>);
-  getDescription(): string;
-  toProfileVariableDefinition(): IProfileArray;
+    type: "array";
+    isCollection: false;
+    elementType: IProfileVariable;
+    constructor(props: ConstructorProperties<IProfileArray>);
+    getDescription(): string;
+    toProfileVariableDefinition(): IProfileArray;
 }
 /**
  * Represents a collection of items. The collection of items can be synchronous or
@@ -131,104 +131,104 @@ export declare class ArrayVariable extends VariableBase {
  * collection is ready or not.
  */
 export declare abstract class CollectionBasedVariable extends VariableBase {
-  isCollection: true;
-  protected _loaded: boolean;
-  /**
-   * The collection of items used to display the profile.
-   * If the collection is asynchronous, the 'load' function should
-   * be called first before using the items.
-   */
-  variables: Array<EditorVariable | GroupOfVariables>;
-  constructor(props: ConstructorProperties<IProfileVariableBase>);
-  /**
-   * Returns true if the collection has been loaded
-   */
-  get loaded(): boolean;
-  /**
-   * Loads the items if the collection is asynchronous.
-   * If the colleciton is synchronous then the function is a no-op.
-   */
-  loadSource(): Promise<unknown>;
-  /**
-   * Returns an url to the associated information
-   */
-  get informationUrl(): string | null;
-  get informationType(): string;
+    isCollection: true;
+    protected _loaded: boolean;
+    /**
+     * The collection of items used to display the profile.
+     * If the collection is asynchronous, the 'load' function should
+     * be called first before using the items.
+     */
+    variables: Array<EditorVariable | GroupOfVariables>;
+    constructor(props: ConstructorProperties<IProfileVariableBase>);
+    /**
+     * Returns true if the collection has been loaded
+     */
+    get loaded(): boolean;
+    /**
+     * Loads the items if the collection is asynchronous.
+     * If the colleciton is synchronous then the function is a no-op.
+     */
+    loadSource(): Promise<unknown>;
+    /**
+     * Returns an url to the associated information
+     */
+    get informationUrl(): string | null;
+    get informationType(): string;
 }
 export declare class GroupOfVariables extends ProfileItemBase {
-  variables: Array<EditorVariable | GroupOfVariables>;
-  type: "group";
-  isCollection: true;
-  constructor(profile: EditorProfile | null | undefined, label: string | IIntlString, variables?: Array<EditorVariable | GroupOfVariables>);
-  passFilter(): boolean;
+    variables: Array<EditorVariable | GroupOfVariables>;
+    type: "group";
+    isCollection: true;
+    constructor(profile: EditorProfile | null | undefined, label: string | IIntlString, variables?: Array<EditorVariable | GroupOfVariables>);
+    passFilter(): boolean;
 }
 export declare class DictionaryVariable extends CollectionBasedVariable {
-  type: "dictionary";
-  /**
-   * The variables that the dictionary holds. It is different than the variables.
-   * The variables may contain grouping.
-   */
-  dictionaryVariables: EditorVariable[];
-  constructor(props: ConstructorProperties<IProfileDictionary>);
-  protected loadPropertyDeclarations(declarations: IProfileVariable[] | undefined): void;
-  private createVariableInstances;
-  private createVariableInstance;
-  toProfileVariableDefinition(): IProfileVariable;
+    type: "dictionary";
+    /**
+     * The variables that the dictionary holds. It is different than the variables.
+     * The variables may contain grouping.
+     */
+    dictionaryVariables: EditorVariable[];
+    constructor(props: ConstructorProperties<IProfileDictionary>);
+    protected loadPropertyDeclarations(declarations: IProfileVariable[] | undefined): void;
+    private createVariableInstances;
+    private createVariableInstance;
+    toProfileVariableDefinition(): IProfileVariable;
 }
 interface IRelationshipsProperties {
-  exposeRelationships: boolean;
-  sourceTableId?: number;
+    exposeRelationships: boolean;
+    sourceTableId?: number;
 }
 declare abstract class SourceBasedVariable extends CollectionBasedVariable {
-  private relationshipsProperties?;
-  protected _definition?: FeatureDefinition | FeatureSetDefinition;
-  protected _source: SupportedSource | null;
-  protected _loadPromise?: Promise<SupportedSource | null>;
-  constructor(props: ConstructorProperties<IProfileFeature | IProfileFeatureSet>, relationshipsProperties?: IRelationshipsProperties | undefined);
-  get title(): string | IIntlString;
-  get url(): string;
-  get informationUrl(): string | null;
-  get informationType(): string;
-  loadSource(): Promise<SupportedSource | null>;
-  protected abstract _loadSource(): Promise<SupportedSource | null>;
-  protected _getFieldProperty(field: __esri.Field): EditorVariable;
-  private _getSubtypesOrDomainValuesDictionary;
-  protected _getRelationshipsProperty(): Promise<GroupOfVariables | null>;
+    private relationshipsProperties?;
+    protected _definition?: FeatureDefinition | FeatureSetDefinition;
+    protected _source: SupportedSource | null;
+    protected _loadPromise?: Promise<SupportedSource | null>;
+    constructor(props: ConstructorProperties<IProfileFeature | IProfileFeatureSet>, relationshipsProperties?: IRelationshipsProperties | undefined);
+    get title(): string | IIntlString;
+    get url(): string;
+    get informationUrl(): string | null;
+    get informationType(): string;
+    loadSource(): Promise<SupportedSource | null>;
+    protected abstract _loadSource(): Promise<SupportedSource | null>;
+    protected _getFieldProperty(field: __esri.Field): EditorVariable;
+    private _getSubtypesOrDomainValuesDictionary;
+    protected _getRelationshipsProperty(): Promise<GroupOfVariables | null>;
 }
 export declare class FeatureVariable extends SourceBasedVariable {
-  type: "feature";
-  constructor(props: ConstructorProperties<IProfileFeature>);
-  get title(): string | IIntlString;
-  protected _loadSource(): Promise<SupportedSource | null>;
-  toProfileVariableDefinition(): IProfileVariable;
+    type: "feature";
+    constructor(props: ConstructorProperties<IProfileFeature>);
+    get title(): string | IIntlString;
+    protected _loadSource(): Promise<SupportedSource | null>;
+    toProfileVariableDefinition(): IProfileVariable;
 }
 export declare class FeatureSetVariable extends SourceBasedVariable {
-  private featureSetSnippets;
-  type: "featureSet";
-  protected _definition?: FeatureSetDefinition;
-  constructor(props: ConstructorProperties<IProfileFeatureSet>, featureSetSnippets?: Array<ValueVariable>, relationshipProps?: IRelationshipsProperties);
-  get title(): string | IIntlString;
-  protected _loadSource(): Promise<SupportedSource | null>;
-  toProfileVariableDefinition(): IProfileVariable;
+    private featureSetSnippets;
+    type: "featureSet";
+    protected _definition?: FeatureSetDefinition;
+    constructor(props: ConstructorProperties<IProfileFeatureSet>, featureSetSnippets?: Array<ValueVariable>, relationshipProps?: IRelationshipsProperties);
+    get title(): string | IIntlString;
+    protected _loadSource(): Promise<SupportedSource | null>;
+    toProfileVariableDefinition(): IProfileVariable;
 }
 export declare class FeatureSetCollectionVariable extends CollectionBasedVariable {
-  type: "featureSetCollection";
-  private _definition?;
-  private _loadPromise?;
-  private _featureSetCollections;
-  constructor(props: ConstructorProperties<IProfileFeatureSetCollection>);
-  get informationUrl(): string | null;
-  get informationType(): string;
-  loadSource(): Promise<IFeatureSetCollections | null>;
-  private _loadSource;
-  private _featureSetCollectionsFromDefinition;
-  private _featureSetCollectionFromWebMap;
-  private _featureSetCollectionFromPortalItem;
-  private _featureSetCollectionFromUrl;
-  private _convertWebMapLayersToVariables;
-  private _createFeatureSetVariable;
-  private _makeFeatureSetSnippets;
-  toProfileVariableDefinition(): IProfileVariable;
+    type: "featureSetCollection";
+    private _definition?;
+    private _loadPromise?;
+    private _featureSetCollections;
+    constructor(props: ConstructorProperties<IProfileFeatureSetCollection>);
+    get informationUrl(): string | null;
+    get informationType(): string;
+    loadSource(): Promise<IFeatureSetCollections | null>;
+    private _loadSource;
+    private _featureSetCollectionsFromDefinition;
+    private _featureSetCollectionFromWebMap;
+    private _featureSetCollectionFromPortalItem;
+    private _featureSetCollectionFromUrl;
+    private _convertWebMapLayersToVariables;
+    private _createFeatureSetVariable;
+    private _makeFeatureSetSnippets;
+    toProfileVariableDefinition(): IProfileVariable;
 }
 /**
  * The EditorProfile is an object that represents an Arcade Profile.
@@ -239,23 +239,23 @@ export declare class FeatureSetCollectionVariable extends CollectionBasedVariabl
  * They need to be loaded asynchronously to get the metadata necessary for validation and completion.
  */
 export declare class EditorProfile extends DictionaryVariable {
-  readonly definition: IEditorProfileDefinition | undefined;
-  readonly intlStrings: IIntlProfileStrings;
-  readonly locale: string;
-  variables: EditorVariable[];
-  constructor(definition: IEditorProfileDefinition | undefined, intlStrings: IIntlProfileStrings, locale?: string);
-  /**
-   * Returns true if the profile supports feature set functions for snippets.
-   */
-  get supportFeatureSetFunctions(): boolean;
-  /**
-   * Returns the language service profile. It is different than the editor profile as it is optimized for Monaco.
-   */
-  toLSProfile(): Promise<ApiProfile>;
-  /**
-   * Returns the EditorProfile as a json. The EditorProfile may have been updated. This function allows to
-   * get the new json representing mutations.
-   */
-  toEditorProfileDefinition(): IEditorProfileDefinition;
+    readonly definition: IEditorProfileDefinition | undefined;
+    readonly intlStrings: IIntlProfileStrings;
+    readonly locale: string;
+    variables: EditorVariable[];
+    constructor(definition: IEditorProfileDefinition | undefined, intlStrings: IIntlProfileStrings, locale?: string);
+    /**
+     * Returns true if the profile supports feature set functions for snippets.
+     */
+    get supportFeatureSetFunctions(): boolean;
+    /**
+     * Returns the language service profile. It is different than the editor profile as it is optimized for Monaco.
+     */
+    toLSProfile(): Promise<ApiProfile>;
+    /**
+     * Returns the EditorProfile as a json. The EditorProfile may have been updated. This function allows to
+     * get the new json representing mutations.
+     */
+    toEditorProfileDefinition(): IEditorProfileDefinition;
 }
 export {};