@arcgis/map-components 5.2.0-next.11 → 5.2.0-next.111

package/dist/components/arcgis-version-management/customElement.d.ts

@@ -3,8 +3,8 @@ import type Collection from "@arcgis/core/core/Collection.js";
 import type VersioningState from "@arcgis/core/versionManagement/VersioningState.js";
 import type MapView from "@arcgis/core/views/MapView.js";
 import type { PublicLitElement as LitElement } from "@arcgis/lumina";
-import type { ArcgisReferenceElement } from "../types.js";
 import type { InitialVersionInfo, VersioningStateEvent } from "./types.js";
+import type { ArcgisReferenceElement } from "../types.js";
 import type { T9nMeta } from "@arcgis/lumina/controllers";
 import type { VersionManagerState } from "@arcgis/core/versionManagement/VersionManager.js";
 
@@ -20,87 +20,9 @@ import type { VersionManagerState } from "@arcgis/core/versionManagement/Version
  * @since 4.29
  */
 export abstract class ArcgisVersionManagement extends LitElement {
-  /** @default false */
-  accessor allowEditingDisabled: boolean;
-  /**
-   * If true, the component will not be destroyed automatically when it is
-   * disconnected from the document. This is useful when you want to move the
-   * component to a different place on the page, or temporarily hide it. If this
-   * is set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-version-management/#destroy) method when you are done to
-   * prevent memory leaks.
-   *
-   * @default false
-   */
-  accessor autoDestroyDisabled: boolean;
-  /** @default false */
-  accessor closable: boolean;
-  /**
-   * Icon which represents the component.
-   * Typically used when the component is controlled by another component (e.g. by the Expand component).
-   *
-   * @see [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)
-   */
-  accessor icon: string | undefined;
-  /**
-   * The `initialVersionInfos` property enables users to initialize the Version Management component with a predefined set of versions.
-   * By providing an array of `InitialVersionInfo`, the component displays a specified version for each feature service upon initialization.
-   */
-  accessor initialVersionInfos: InitialVersionInfo[];
-  accessor label: string | undefined;
-  /**
-   * Replace localized message strings with your own strings.
-   *
-   * _**Note**: Individual message keys may change between releases._
-   */
-  accessor messageOverrides: {
-      label?: string | undefined;
-      actions?: {
-          cancelSave?: string | undefined;
-          deleteVersion?: string | undefined;
-          editVersion?: string | undefined;
-          newVersion?: string | undefined;
-          refreshVersions?: string | undefined;
-          saveVersion?: string | undefined;
-          searchVersions?: string | undefined;
-          switchToVersion?: string | undefined;
-      } | undefined;
-      accessLevels?: {
-          private?: string | undefined;
-          protected?: string | undefined;
-          public?: string | undefined;
-      } | undefined;
-      executionErrors?: {
-          invalidVersionName?: string | undefined;
-          noFeatureServiceFound?: string | undefined;
-          notValidEnterpriseVersion?: string | undefined;
-          noVersionManagementServiceFound?: string | undefined;
-      } | undefined;
-      headers?: {
-          currentVersion?: string | undefined;
-          manageVersions?: string | undefined;
-          filterVersions?: string | undefined;
-          versionProperties?: string | undefined;
-          invalidInitialVersion?: string | undefined;
-          invalidInitialFeatureService?: string | undefined;
-      } | undefined;
-      input?: {
-          versionAccess?: string | undefined;
-          versionDescription?: string | undefined;
-          versionName?: string | undefined;
-          versionOwner?: string | undefined;
-      } | undefined;
-      labels?: { versionList?: string | undefined; } | undefined;
-      loadErrors?: {
-          invalidInitialVersion?: string | undefined;
-          invalidInitialFeatureService?: string | undefined;
-          noFeatureServices?: string | undefined;
-          noViewProperty?: string | undefined;
-      } | undefined;
-      validationErrors?: { invalidCharacters?: string | undefined; } | undefined;
-  };
   /** @internal */
-  protected messages: {
-      label: string;
+  protected _messages: {
+      componentLabel: string;
       actions: {
           cancelSave: string;
           deleteVersion: string;
@@ -120,15 +42,15 @@ export abstract class ArcgisVersionManagement extends LitElement {
           invalidVersionName: string;
           noFeatureServiceFound: string;
           notValidEnterpriseVersion: string;
-          noVersionManagementServiceFound: string;
       };
       headers: {
           currentVersion: string;
-          manageVersions: string;
           filterVersions: string;
-          versionProperties: string;
-          invalidInitialVersion: string;
           invalidInitialFeatureService: string;
+          invalidInitialVersion: string;
+          manageVersions: string;
+          versioningStateFailedToLoad: string;
+          versionProperties: string;
       };
       input: {
           versionAccess: string;
@@ -138,14 +60,20 @@ export abstract class ArcgisVersionManagement extends LitElement {
       };
       labels: { versionList: string; };
       loadErrors: {
-          invalidInitialVersion: string;
           invalidInitialFeatureService: string;
+          invalidInitialVersion: string;
           noFeatureServices: string;
+          noVersionManagementServiceFound: string;
           noViewProperty: string;
+          versioningStateFailedToLoad: string;
+          webmapFailedToLoad: string;
+      };
+      validationErrors: {
+          emptyVersionName: string;
+          invalidCharacters: string;
       };
-      validationErrors: { invalidCharacters: string; };
   } & T9nMeta<{
-      label: string;
+      componentLabel: string;
       actions: {
           cancelSave: string;
           deleteVersion: string;
@@ -165,15 +93,15 @@ export abstract class ArcgisVersionManagement extends LitElement {
           invalidVersionName: string;
           noFeatureServiceFound: string;
           notValidEnterpriseVersion: string;
-          noVersionManagementServiceFound: string;
       };
       headers: {
           currentVersion: string;
-          manageVersions: string;
           filterVersions: string;
-          versionProperties: string;
-          invalidInitialVersion: string;
           invalidInitialFeatureService: string;
+          invalidInitialVersion: string;
+          manageVersions: string;
+          versioningStateFailedToLoad: string;
+          versionProperties: string;
       };
       input: {
           versionAccess: string;
@@ -183,13 +111,114 @@ export abstract class ArcgisVersionManagement extends LitElement {
       };
       labels: { versionList: string; };
       loadErrors: {
-          invalidInitialVersion: string;
           invalidInitialFeatureService: string;
+          invalidInitialVersion: string;
           noFeatureServices: string;
+          noVersionManagementServiceFound: string;
           noViewProperty: string;
+          versioningStateFailedToLoad: string;
+          webmapFailedToLoad: string;
+      };
+      validationErrors: {
+          emptyVersionName: string;
+          invalidCharacters: string;
       };
-      validationErrors: { invalidCharacters: string; };
   }>;
+  /** @default false */
+  accessor allowEditingDisabled: boolean;
+  /**
+   * If true, the component will not be destroyed automatically when it is
+   * disconnected from the document. This is useful when you want to move the
+   * component to a different place on the page, or temporarily hide it. If this
+   * is set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-version-management/#destroy) method when you are done to
+   * prevent memory leaks.
+   *
+   * @default false
+   * @example
+   * ```html
+   * <arcgis-version-management auto-destroy-disabled></arcgis-version-management>
+   * ```
+   *
+   * ```js
+   * versionManagementElement.autoDestroyDisabled = true;
+   * ```
+   * 
+   */
+  accessor autoDestroyDisabled: boolean;
+  /** @default false */
+  accessor closable: boolean;
+  /**
+   * Icon which represents the component.
+   * Typically used when the component is controlled by another component (e.g. by the Expand component).
+   *
+   * @see [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)
+   */
+  accessor icon: string | undefined;
+  /**
+   * The `initialVersionInfos` property enables users to initialize the Version Management component with a predefined set of versions.
+   * By providing an array of `InitialVersionInfo`, the component displays a specified version for each feature service upon initialization.
+   */
+  accessor initialVersionInfos: InitialVersionInfo[];
+  /** The component's default label. */
+  accessor label: string | undefined;
+  /**
+   * Replace localized message strings with your own strings.
+   *
+   * _**Note**: Individual message keys may change between releases._
+   */
+  accessor messageOverrides: {
+      componentLabel?: string | undefined;
+      actions?: {
+          cancelSave?: string | undefined;
+          deleteVersion?: string | undefined;
+          editVersion?: string | undefined;
+          newVersion?: string | undefined;
+          refreshVersions?: string | undefined;
+          saveVersion?: string | undefined;
+          searchVersions?: string | undefined;
+          switchToVersion?: string | undefined;
+      } | undefined;
+      accessLevels?: {
+          private?: string | undefined;
+          protected?: string | undefined;
+          public?: string | undefined;
+      } | undefined;
+      executionErrors?: {
+          invalidVersionName?: string | undefined;
+          noFeatureServiceFound?: string | undefined;
+          notValidEnterpriseVersion?: string | undefined;
+      } | undefined;
+      headers?: {
+          currentVersion?: string | undefined;
+          filterVersions?: string | undefined;
+          invalidInitialFeatureService?: string | undefined;
+          invalidInitialVersion?: string | undefined;
+          manageVersions?: string | undefined;
+          versioningStateFailedToLoad?: string | undefined;
+          versionProperties?: string | undefined;
+      } | undefined;
+      input?: {
+          versionAccess?: string | undefined;
+          versionDescription?: string | undefined;
+          versionName?: string | undefined;
+          versionOwner?: string | undefined;
+      } | undefined;
+      labels?: { versionList?: string | undefined; } | undefined;
+      loadErrors?: {
+          invalidInitialFeatureService?: string | undefined;
+          invalidInitialVersion?: string | undefined;
+          noFeatureServices?: string | undefined;
+          noVersionManagementServiceFound?: string | undefined;
+          noViewProperty?: string | undefined;
+          versioningStateFailedToLoad?: string | undefined;
+          webmapFailedToLoad?: string | undefined;
+      } | undefined;
+      validationErrors?: {
+          emptyVersionName?: string | undefined;
+          invalidCharacters?: string | undefined;
+      } | undefined;
+  };
+  /** @deprecated since 5.2. */
   accessor mode: string | undefined;
   /**
    * Specifies the number of versions displayed on each page of the Version Management component.
@@ -206,7 +235,7 @@ export abstract class ArcgisVersionManagement extends LitElement {
   /**
    * The current component state.
    *
-   * * `disabled` -  an error occured during initialization
+   * * `disabled` -  an error occurred during initialization
    * * `executing` - an operation is being performed
    * * `failed` - an error occurred during execution
    * * `loading` - the object is loading
@@ -233,7 +262,7 @@ export abstract class ArcgisVersionManagement extends LitElement {
   accessor view: MapView | undefined;
   /** Permanently destroy the component. */
   destroy(): Promise<void>;
-  /** Emitted when the component associated with a map or scene view is ready to be interacted with. */
+  /** Emitted when the component associated with a map or scene view is ready for user interaction. */
   readonly arcgisReady: import("@arcgis/lumina").TargetedEvent<this, void>;
   readonly arcgisVersioningStateChanged: import("@arcgis/lumina").TargetedEvent<this, VersioningStateEvent>;
   readonly "@eventTypes": {