@arcgis/coding-components 4.29.0-beta.107 → 4.29.0-beta.109

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

@@ -1,10 +1,5 @@
-import type { 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 IndexedProfileStrings = ProfileStrings & Record<string, string | undefined>;
-/**
- * Describe the support source for some of the editor variables.
- */
-type SupportedSource = __esri.FeatureSet | IFieldsDefinition | SupportedLayer;
+import type { ApiVariableType, ApiProfile } from "@arcgis/arcade-languageservice";
+import type * as types from "./types";
 /**
  * FeatureSetCollection interface. Used in Arcade expressions to represent Web Maps
  * or Feature Services.
@@ -26,29 +21,13 @@ interface IFeatureSetCollections {
      */
     source: __esri.WebMap | __esri.WebScene | 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>;
-}
 type ProfileItemType = ApiVariableType | "group";
 export type EditorVariable = ArrayVariable | DictionaryVariable | FeatureSetCollectionVariable | FeatureSetVariable | FeatureVariable | ValueVariable;
 interface ConstructorProperties<T> {
     profile?: EditorProfile | null;
     declaration?: Partial<T>;
-    label?: IIntlString | string;
-    description?: IIntlString | string;
+    label?: types.IIntlString | string;
+    description?: types.IIntlString | string;
     snippet?: string;
     nonInteractive?: boolean;
     filterDescription?: boolean;
@@ -62,14 +41,14 @@ interface ConstructorProperties<T> {
 declare abstract class ProfileItemBase {
     protected _profile: EditorProfile | null | undefined;
     private readonly _label;
-    protected readonly description?: string | IIntlString | undefined;
+    protected readonly description?: string | types.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: IIntlString | string | undefined, description?: string | IIntlString | undefined);
+    constructor(_profile: EditorProfile | null | undefined, _label: types.IIntlString | string | undefined, description?: string | types.IIntlString | undefined);
     /**
      * Returns the label string.
      */
@@ -94,23 +73,23 @@ declare abstract class VariableBase extends ProfileItemBase {
      * True if the variable doesn't can be used as snippet by the editor.
      */
     readonly nonInteractive: boolean;
-    protected declaration: Partial<IProfileVariableBase>;
+    protected declaration: Partial<types.IProfileVariableBase>;
     icon: string | undefined;
-    constructor(props: ConstructorProperties<IProfileVariableBase>);
+    constructor(props: ConstructorProperties<types.IProfileVariableBase>);
     /**
      * Returns the IProfileVariable json representation.
      */
-    abstract toProfileVariableDefinition(): IProfileVariable;
+    abstract toProfileVariableDefinition(): types.IProfileVariable;
 }
 /**
  * Represents the IProfileValue.
  */
 export declare class ValueVariable extends VariableBase {
-    type: ProfileVariableValueType;
+    type: types.ProfileVariableValueType;
     isCollection: false;
-    constructor(props: ConstructorProperties<IProfileValue>);
+    constructor(props: ConstructorProperties<types.IProfileValue>);
     getDescription(): string;
-    toProfileVariableDefinition(): IProfileVariable;
+    toProfileVariableDefinition(): types.IProfileVariable;
 }
 /**
  * Represents the IProfileArray. The main difference is that the IProfileValue type
@@ -119,10 +98,10 @@ export declare class ValueVariable extends VariableBase {
 export declare class ArrayVariable extends VariableBase {
     type: "array";
     isCollection: false;
-    elementType: IProfileVariable;
-    constructor(props: ConstructorProperties<IProfileArray>);
+    elementType: types.IProfileVariable;
+    constructor(props: ConstructorProperties<types.IProfileArray>);
     getDescription(): string;
-    toProfileVariableDefinition(): IProfileArray;
+    toProfileVariableDefinition(): types.IProfileArray;
 }
 /**
  * Represents a collection of items. The collection of items can be synchronous or
@@ -131,6 +110,7 @@ export declare class ArrayVariable extends VariableBase {
  * collection is ready or not.
  */
 export declare abstract class CollectionBasedVariable extends VariableBase {
+    private owner;
     isCollection: true;
     protected _loaded: boolean;
     /**
@@ -139,6 +119,8 @@ export declare abstract class CollectionBasedVariable extends VariableBase {
      * be called first before using the items.
      */
     variables: (EditorVariable | GroupOfVariables)[];
+    constructor(owner: CollectionBasedVariable | undefined, props: ConstructorProperties<types.IProfileVariableBase>);
+    get breadcrumb(): string;
     /**
      * Returns true if the collection has been loaded
      */
@@ -147,7 +129,7 @@ export declare abstract class CollectionBasedVariable extends VariableBase {
      * Loads the items if the collection is asynchronous.
      * If the colleciton is synchronous then the function is a no-op.
      */
-    loadSource(): Promise<unknown>;
+    abstract loadSource(): Promise<unknown>;
     /**
      * Returns an url to the associated information
      */
@@ -158,7 +140,7 @@ export declare class GroupOfVariables extends ProfileItemBase {
     variables: (EditorVariable | GroupOfVariables)[];
     type: "group";
     isCollection: true;
-    constructor(profile: EditorProfile | null | undefined, label: IIntlString | string, variables?: (EditorVariable | GroupOfVariables)[]);
+    constructor(profile: EditorProfile | null | undefined, label: types.IIntlString | string, variables?: (EditorVariable | GroupOfVariables)[]);
     passFilter(): boolean;
 }
 export declare class DictionaryVariable extends CollectionBasedVariable {
@@ -168,11 +150,12 @@ export declare class DictionaryVariable extends CollectionBasedVariable {
      * The variables may contain grouping.
      */
     dictionaryVariables: EditorVariable[];
-    constructor(props: ConstructorProperties<IProfileDictionary>);
-    protected loadPropertyDeclarations(declarations: IProfileVariable[] | undefined): void;
+    constructor(owner: CollectionBasedVariable | undefined, props: ConstructorProperties<types.IProfileDictionary>);
+    loadSource(): Promise<void>;
+    protected loadPropertyDeclarations(declarations: types.IProfileVariable[] | undefined): void;
     private createVariableInstances;
     private createVariableInstance;
-    toProfileVariableDefinition(): IProfileVariable;
+    toProfileVariableDefinition(): types.IProfileVariable;
 }
 interface IRelationshipsProperties {
     exposeRelationships: boolean;
@@ -180,16 +163,16 @@ interface IRelationshipsProperties {
 }
 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(): IIntlString | string;
+    protected _definition?: types.FeatureDefinition | types.FeatureSetDefinition;
+    protected _source: types.SupportedSource | null;
+    protected _loadPromise?: Promise<types.SupportedSource | null>;
+    constructor(owner: CollectionBasedVariable | undefined, props: ConstructorProperties<types.IProfileFeature | types.IProfileFeatureSet>, relationshipsProperties?: IRelationshipsProperties | undefined);
+    get title(): types.IIntlString | string;
     get url(): string;
     get informationUrl(): string | null;
     get informationType(): string;
-    loadSource(): Promise<SupportedSource | null>;
-    protected abstract _loadSource(): Promise<SupportedSource | null>;
+    loadSource(): Promise<types.SupportedSource | null>;
+    protected abstract _loadSource(): Promise<types.SupportedSource | null>;
     private _getValueSnippet;
     private _getSubtypeOrDomainNameSnippet;
     protected _getFieldProperty(field: __esri.Field): EditorVariable;
@@ -197,31 +180,34 @@ declare abstract class SourceBasedVariable extends CollectionBasedVariable {
     private _getSubtypeDomainDictionary;
     private _getFeatureTypeDomainDictionary;
     private _getFieldDomainDictionary;
+    private _getTypeOrSubtypeDomainGroup;
+    private _getCodedValueDomainGroup;
+    private _getDomainValuesGroup;
     protected _createDomainDictionary(field: __esri.Field): DictionaryVariable;
     protected _getRelationshipsProperty(): Promise<GroupOfVariables | null>;
 }
 export declare class FeatureVariable extends SourceBasedVariable {
     type: "feature";
-    constructor(props: ConstructorProperties<IProfileFeature>);
-    get title(): IIntlString | string;
-    protected _loadSource(): Promise<SupportedSource | null>;
-    toProfileVariableDefinition(): IProfileVariable;
+    constructor(owner: CollectionBasedVariable | undefined, props: ConstructorProperties<types.IProfileFeature>);
+    get title(): types.IIntlString | string;
+    protected _loadSource(): Promise<types.SupportedSource | null>;
+    toProfileVariableDefinition(): types.IProfileVariable;
 }
 export declare class FeatureSetVariable extends SourceBasedVariable {
     private featureSetSnippets;
     type: "featureSet";
-    protected _definition?: FeatureSetDefinition;
-    constructor(props: ConstructorProperties<IProfileFeatureSet>, featureSetSnippets?: ValueVariable[], relationshipProps?: IRelationshipsProperties);
-    get title(): IIntlString | string;
-    protected _loadSource(): Promise<SupportedSource | null>;
-    toProfileVariableDefinition(): IProfileVariable;
+    protected _definition?: types.FeatureSetDefinition;
+    constructor(owner: CollectionBasedVariable | undefined, props: ConstructorProperties<types.IProfileFeatureSet>, featureSetSnippets?: ValueVariable[], relationshipProps?: IRelationshipsProperties);
+    get title(): types.IIntlString | string;
+    protected _loadSource(): Promise<types.SupportedSource | null>;
+    toProfileVariableDefinition(): types.IProfileVariable;
 }
 export declare class FeatureSetCollectionVariable extends CollectionBasedVariable {
     type: "featureSetCollection";
     private _definition?;
     private _loadPromise?;
     private _featureSetCollections;
-    constructor(props: ConstructorProperties<IProfileFeatureSetCollection>);
+    constructor(owner: CollectionBasedVariable | undefined, props: ConstructorProperties<types.IProfileFeatureSetCollection>);
     get informationUrl(): string | null;
     get informationType(): string;
     loadSource(): Promise<IFeatureSetCollections | null>;
@@ -233,7 +219,7 @@ export declare class FeatureSetCollectionVariable extends CollectionBasedVariabl
     private _convertWebMapLayersToVariables;
     private _createFeatureSetVariable;
     private _makeFeatureSetSnippets;
-    toProfileVariableDefinition(): IProfileVariable;
+    toProfileVariableDefinition(): types.IProfileVariable;
 }
 /**
  * The EditorProfile is an object that represents an Arcade Profile.
@@ -244,11 +230,11 @@ 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: IndexedProfileStrings;
+    readonly definition: types.IEditorProfileDefinition | undefined;
+    readonly intlStrings: types.IndexedProfileStrings;
     readonly locale: string;
     variables: EditorVariable[];
-    constructor(definition: IEditorProfileDefinition | undefined, intlStrings: IndexedProfileStrings, locale?: string);
+    constructor(definition: types.IEditorProfileDefinition | undefined, intlStrings: types.IndexedProfileStrings, locale?: string);
     /**
      * Returns true if the profile supports feature set functions for snippets.
      */
@@ -261,6 +247,6 @@ export declare class EditorProfile extends DictionaryVariable {
      * Returns the EditorProfile as a json. The EditorProfile may have been updated. This function allows to
      * get the new json representing mutations.
      */
-    toEditorProfileDefinition(): IEditorProfileDefinition;
+    toEditorProfileDefinition(): types.IEditorProfileDefinition;
 }
 export {};

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

@@ -1,4 +1,4 @@
-import type { BundleType, ApiItem, ApiVariableType, ProfileId } from "@arcgis/arcade-languageservice";
+import type { BundleType, ApiItem, ApiVariableType, ProfileId, ProfileStrings } from "@arcgis/arcade-languageservice";
 /**
  * Editor Profile definition used for configuring the editor:
  * - presenting to the user the Arcade API
@@ -208,3 +208,124 @@ export interface IPredefinedProfile {
      */
     hiddenApiItems?: string[];
 }
+export type IndexedProfileStrings = ProfileStrings & Record<string, string | undefined>;
+/**
+ * Describe the support source for some of the editor variables.
+ */
+export type SupportedSource = __esri.FeatureSet | IFieldsDefinition | SupportedLayer;
+/**
+ * Layer that supports title.
+ */
+export interface ITitleCapableSource {
+    /**
+     * The title of the source.
+     */
+    title: string;
+}
+/**
+ * Layer that supports url.
+ */
+export interface IUrlCapableSource {
+    /**
+     * The url of the source.
+     */
+    url: string;
+}
+/**
+ * Layer that supports layer id.
+ */
+export interface ILayerIdCapableSource {
+    /**
+     * The layer id of the source.
+     */
+    layerId: number;
+}
+/**
+ * Layer that supports field domains.
+ */
+export interface IDomainsCapableSource {
+    /**
+     * Returns the Domain associated with the given field name.
+     */
+    getFieldDomain: (fieldName: string) => __esri.Domain | null;
+}
+/**
+ * Layer that implements types
+ */
+export interface IFeatureTypesCapableSource extends IDomainsCapableSource {
+    /**
+     * The name of the field holding the type ID or subtypes for the features.
+     */
+    typeIdField: string;
+    /**
+     * An array of subtypes defined in the feature service exposed by ArcGIS REST API.
+     */
+    types: __esri.FeatureType[];
+}
+/**
+ * Layer that has a subtype field
+ */
+export interface ISubtypeFieldCapableSource extends IDomainsCapableSource {
+    /**
+     * The name of the field which holds the id of the subtypes.
+     */
+    subtypeField: string;
+}
+/**
+ * Layer that exposes subtypes.
+ */
+export interface ISubtypesCapableSource extends ISubtypeFieldCapableSource {
+    /**
+     * An array of subtypes defined in the layer.
+     */
+    subtypes: __esri.Subtype[];
+}
+/**
+ * Layer that supports relationships.
+ */
+export interface IRelationshipsCapableSource extends ILayerIdCapableSource {
+    /**
+     * Array of relationships set up for the layer.
+     */
+    relationships: __esri.Relationship[];
+    /**
+     * The absolute URL of the REST endpoint of the layer, non-spatial table or service.
+     */
+    url: string;
+}
+/**
+ * Layer that is capable of being npn-spatial.
+ */
+export interface ITableCapableSource {
+    /**
+     * Returns `true` if the layer is loaded from a non-spatial table in a service.
+     */
+    isTable: boolean;
+}
+export interface ILoadableSource {
+    /**
+     * Loads the resources referenced by the layer.
+     */
+    load: (signal?: AbortSignal) => Promise<any>;
+}
+/**
+ * Represents a string that will have to be manufactured from a Intl strings resource.
+ */
+export 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>;
+}
+export interface LayerInfo {
+    id: number;
+    type: string;
+    capabilities?: string;
+}

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

@@ -1,19 +1,32 @@
-import type { IFeatureLayerItemDefinition, IFieldsDefinition, IPortalItemDefinition, IPredefinedProfile, IUrlDefinition, SupportedLayer } from "./types";
-export declare function newPortalItem(definition: __esri.PortalItemProperties): Promise<__esri.PortalItem>;
+import type * as types from "./types";
 export declare function newFeatureLayer(definition: __esri.FeatureLayerProperties): Promise<__esri.FeatureLayer>;
-export declare function newWebMap(definition: __esri.WebMapProperties): Promise<__esri.WebMap>;
-export declare function isSupportedLayerInstance(item: unknown): item is SupportedLayer;
+export declare function isSupportedLayerInstance(item: unknown): item is types.SupportedLayer;
 export declare function isFeatureSetInstance(item: unknown): item is __esri.FeatureSet;
 export declare function isQueryableLayerInstance(item: unknown): item is __esri.FeatureLayer;
 export declare function isSubtypeSublayerInstance(item: unknown): item is __esri.SubtypeSublayer;
 export declare function isGroupLayerInstance(item: unknown): item is __esri.GroupLayer;
 export declare function isMapImageLayerInstance(item: unknown): item is __esri.MapImageLayer;
 export declare function isMapInstance(item: unknown): item is __esri.WebMap | __esri.WebScene;
-export declare function isPortalItemDefinition(item: unknown): item is IPortalItemDefinition;
-export declare function isFeatureLayerItemDefinition(item: unknown): item is IFeatureLayerItemDefinition;
-export declare function isFieldsDefinition(item: unknown): item is IFieldsDefinition;
-export declare function isUrlDefinition(item: unknown): item is IUrlDefinition;
+export declare function isPortalItemDefinition(item: unknown): item is types.IPortalItemDefinition;
+export declare function isFeatureLayerItemDefinition(item: unknown): item is types.IFeatureLayerItemDefinition;
+export declare function isFieldsDefinition(item: unknown): item is types.IFieldsDefinition;
+export declare function isUrlDefinition(item: unknown): item is types.IUrlDefinition;
 export declare function isSubtypeInstance(item: unknown): item is __esri.Subtype;
 export declare function isCodedValueDomainInstance(item: unknown): item is __esri.CodedValueDomain;
 export declare function isInheritedDomainInstance(item: unknown): item is __esri.InheritedDomain;
-export declare function isPredefinedProfile(item: unknown): item is IPredefinedProfile;
+export declare function isPredefinedProfile(item: unknown): item is types.IPredefinedProfile;
+export declare function isTitleCapableSource(item: unknown): item is types.ITitleCapableSource;
+export declare function isUrlCapableSource(item: unknown): item is types.IUrlCapableSource;
+export declare function isLayerIdCapableSource(item: unknown): item is types.ILayerIdCapableSource;
+export declare function isFeatureTypesCapableLayer(item: unknown): item is types.IFeatureTypesCapableSource;
+export declare function isDomainsCapableLayer(item: unknown): item is types.IDomainsCapableSource;
+export declare function isSubtypeFieldCapableLayer(item: unknown): item is types.ISubtypeFieldCapableSource;
+export declare function isSubtypesCapableLayer(item: unknown): item is types.ISubtypesCapableSource;
+export declare function isRelationshipsCapableLayer(item: unknown): item is types.IRelationshipsCapableSource;
+export declare function isTableCapableLayer(item: unknown): item is types.ITableCapableSource;
+export declare function isLoadableSource(item: unknown): item is types.ILoadableSource;
+export declare function supportedSourceFromDefinition(definition: types.FeatureDefinition | types.FeatureSetDefinition | null | undefined): Promise<types.SupportedSource | null>;
+export declare function serviceMetaData(url: string): Promise<{
+    layers: types.LayerInfo[];
+    tables: types.LayerInfo[];
+}>;

package/package.json

@@ -2,7 +2,7 @@
   "name": "@arcgis/coding-components",
   "description": "Contains components for editing code in different languages. The currently supported languages are html, css, json, TypeScript, JavaScript, and Arcade.",
   "homepage": "https://developers.arcgis.com/javascript/latest/",
-  "version": "4.29.0-beta.107",
+  "version": "4.29.0-beta.109",
   "module": "dist/components/index.js",
   "main": "dist/index.cjs.js",
   "types": "dist/types/index.d.ts",
@@ -48,18 +48,18 @@
     "generate": "stencil generate"
   },
   "dependencies": {
-    "@arcgis/arcade-languageservice": "4.29.0-beta.107",
+    "@arcgis/arcade-languageservice": "4.29.0-beta.109",
     "@stencil/core": "^4.10.0",
     "monaco-editor": "^0.45.0",
     "vscode-languageserver-types": "^3.17.3"
   },
   "devDependencies": {
-    "@arcgis/components-plugins": "4.29.0-beta.107",
-    "@arcgis/components-utils": "4.29.0-beta.107",
+    "@arcgis/components-plugins": "4.29.0-beta.109",
+    "@arcgis/components-utils": "4.29.0-beta.109",
     "@arcgis/core": ">=4.29.0-next <4.30",
-    "@arcgis/core-adapter": "4.29.0-beta.107",
-    "@arcgis/storybook-utils": "4.29.0-beta.107",
-    "@arcgis/typescript-config": "4.29.0-beta.107",
+    "@arcgis/core-adapter": "4.29.0-beta.109",
+    "@arcgis/storybook-utils": "4.29.0-beta.109",
+    "@arcgis/typescript-config": "4.29.0-beta.109",
     "@esri/calcite-components": "^2.4.0",
     "@stencil/angular-output-target": "0.8.3",
     "@stencil/react-output-target": "0.5.3",
@@ -98,5 +98,5 @@
     "@arcgis/core": ">=4.29.0-next <4.30",
     "@esri/calcite-components": ">=2.2.0 <3.0.0"
   },
-  "gitHead": "760edc8d4985e507ecb5bfb85d53454a1f3bb2ef"
+  "gitHead": "87e80be1dbe5580979d180181496957e76d22cb4"
 }