@arcgis/portal-components 5.2.0-next.15 → 5.2.0-next.151

package/dist/components/arcgis-portal-delete-items/customElement.d.ts

@@ -0,0 +1,280 @@
+/// <reference path="../../index.d.ts" />
+import type PortalItem from "@arcgis/core/portal/PortalItem.js";
+import type Portal from "@arcgis/core/portal/Portal.js";
+import type PortalUser from "@arcgis/core/portal/PortalUser.js";
+import type { PublicLitElement as LitElement } from "@arcgis/lumina";
+import type { DeleteItemResponse } from "./services.js";
+import type { APIResponse } from "../../utils/types.js";
+import type { T9nMeta } from "@arcgis/lumina/controllers";
+
+/**
+ * Displays a confirmation dialog for deleting portal items.
+ *
+ * @internal
+ */
+export abstract class ArcgisPortalDeleteItems extends LitElement {
+  /**
+   * Whether or not the delete items modal is open.
+   *
+   * @default true
+   */
+  accessor active: boolean;
+  /**
+   * If true, the selected items do not contain links to item details.
+   * Generally used when already on item details, or if it's already known
+   * that an item does not exist.
+   *
+   * @default false
+   */
+  accessor disableLinks: boolean;
+  /**
+   * For `Learn more`. TODO: Move the string to common post-2026R03
+   *
+   * @internal
+   */
+  protected fieldDeleteMessages: Partial<{
+      cancel: string;
+      error: string;
+      errorOccurred: string;
+      fields: string;
+      deletePrompt: string;
+      deleteMultiplePrompt: string;
+      deleteField: string;
+      deleteFields: string;
+      deleteFieldsWithNumber: string;
+      deletingField: string;
+      deletingFields: string;
+      newFeature: string;
+      fieldDeleted: string;
+      fieldsDeleted: string;
+      fieldDeletionUnsuccessful: string;
+      fieldInUse: string;
+      expressions: string;
+      popups: string;
+      forms: string;
+      charts: string;
+      deleteWarning: string;
+      deleteMultipleWarning: string;
+      learnMore: string;
+      savingFailed: string;
+      readOnlyErrorMessage: string;
+      readOnlyErrorMessageEnterprise: string;
+      healthDashboard: string;
+  }> & T9nMeta<{
+      cancel: string;
+      error: string;
+      errorOccurred: string;
+      fields: string;
+      deletePrompt: string;
+      deleteMultiplePrompt: string;
+      deleteField: string;
+      deleteFields: string;
+      deleteFieldsWithNumber: string;
+      deletingField: string;
+      deletingFields: string;
+      newFeature: string;
+      fieldDeleted: string;
+      fieldsDeleted: string;
+      fieldDeletionUnsuccessful: string;
+      fieldInUse: string;
+      expressions: string;
+      popups: string;
+      forms: string;
+      charts: string;
+      deleteWarning: string;
+      deleteMultipleWarning: string;
+      learnMore: string;
+      savingFailed: string;
+      readOnlyErrorMessage: string;
+      readOnlyErrorMessageEnterprise: string;
+      healthDashboard: string;
+  }>;
+  /** The IDs of the items to load when no `items` are provided. */
+  accessor itemIds: string[];
+  /** The portal items to delete. Takes precedence over `itemIds` when included. */
+  accessor items: PortalItem[];
+  /** @internal */
+  protected messages: {
+      deleteItem: string;
+      deleteItems: string;
+      selectedItems: string;
+      reviewItemsCount: string;
+      reviewItemsDescription: string;
+      delete: string;
+      permanentlyDelete: string;
+      permanentlyDeleteInstead: string;
+      deprecate: string;
+      confirm: string;
+      cancel: string;
+      moreInfo: string;
+      bucketItems: string;
+      directlyUsedBy: string;
+      usedByOtherItems: {
+          single: string;
+          multiple: string;
+          unknown: string;
+      };
+      usedByPopover: string;
+      deleteDiscouraged: string;
+      learnMoreAboutDeletingSourceItems: string;
+      reviewRelatedItems: { multiple: string; };
+      reviewItems: string;
+      reviewItemsList: string;
+      exclude: string;
+      deprecateInstead: string;
+      proceedToDelete: string;
+      proceedWithDeletion: string;
+      relatedItemsReviewed: string;
+      reviewImpactedItems: string;
+      summary: {
+          willBeRecycled: string;
+          deprecate: {
+              label: string;
+              message: string;
+          };
+          exclude: {
+              label: string;
+              message: string;
+          };
+          cannotDelete: string;
+          permanentlyDelete: string;
+          canBeRecovered: { single: string; };
+          permanentDelete: {
+              delete: string;
+              notSupported: { single: string; };
+              default: { single: string; };
+          };
+          protectedGroup: {
+              deleteProtectedDescription: string;
+              hasDependentItemsDescription: {
+                  singleOneDependentItem: string;
+                  singleMultipleDependentItems: string;
+              };
+          };
+      };
+      areYouSure: { multiple: string; };
+      deletingWillImpactOtherItems: string;
+      itemsDependingOnThisItem: string;
+      dependentItems: string;
+      dependentItemsWillBeDeletedTogether: string;
+      impactedItems: {
+          title: string;
+          itemsYouHaveAccessTo: string;
+          "View usage": string;
+          "View full list": string;
+      };
+      replacementItem: {
+          isReplacementFor: {
+              single: string;
+              multiple: string;
+              unknown: string;
+          };
+          itemIsReplacedBySelectedItem: string;
+      };
+  } & T9nMeta<{
+      deleteItem: string;
+      deleteItems: string;
+      selectedItems: string;
+      reviewItemsCount: string;
+      reviewItemsDescription: string;
+      delete: string;
+      permanentlyDelete: string;
+      permanentlyDeleteInstead: string;
+      deprecate: string;
+      confirm: string;
+      cancel: string;
+      moreInfo: string;
+      bucketItems: string;
+      directlyUsedBy: string;
+      usedByOtherItems: {
+          single: string;
+          multiple: string;
+          unknown: string;
+      };
+      usedByPopover: string;
+      deleteDiscouraged: string;
+      learnMoreAboutDeletingSourceItems: string;
+      reviewRelatedItems: { multiple: string; };
+      reviewItems: string;
+      reviewItemsList: string;
+      exclude: string;
+      deprecateInstead: string;
+      proceedToDelete: string;
+      proceedWithDeletion: string;
+      relatedItemsReviewed: string;
+      reviewImpactedItems: string;
+      summary: {
+          willBeRecycled: string;
+          deprecate: {
+              label: string;
+              message: string;
+          };
+          exclude: {
+              label: string;
+              message: string;
+          };
+          cannotDelete: string;
+          permanentlyDelete: string;
+          canBeRecovered: { single: string; };
+          permanentDelete: {
+              delete: string;
+              notSupported: { single: string; };
+              default: { single: string; };
+          };
+          protectedGroup: {
+              deleteProtectedDescription: string;
+              hasDependentItemsDescription: {
+                  singleOneDependentItem: string;
+                  singleMultipleDependentItems: string;
+              };
+          };
+      };
+      areYouSure: { multiple: string; };
+      deletingWillImpactOtherItems: string;
+      itemsDependingOnThisItem: string;
+      dependentItems: string;
+      dependentItemsWillBeDeletedTogether: string;
+      impactedItems: {
+          title: string;
+          itemsYouHaveAccessTo: string;
+          "View usage": string;
+          "View full list": string;
+      };
+      replacementItem: {
+          isReplacementFor: {
+              single: string;
+              multiple: string;
+              unknown: string;
+          };
+          itemIsReplacedBySelectedItem: string;
+      };
+  }>;
+  /** The portal instance. */
+  accessor portal: Portal;
+  /** The user performing deletion. */
+  accessor user: PortalUser | null | undefined;
+  /** Emitted when the user cancels the deletion. */
+  readonly arcgisClose: import("@arcgis/lumina").TargetedEvent<this, void>;
+  /** Emitted when the user confirms the deletion. */
+  readonly arcgisConfirm: import("@arcgis/lumina").TargetedEvent<this, DeleteItemsPayload>;
+  /** Emitted when an error occurs during deletion. */
+  readonly arcgisError: import("@arcgis/lumina").TargetedEvent<this, DeleteItemsPayload>;
+  readonly "@eventTypes": {
+    arcgisClose: ArcgisPortalDeleteItems["arcgisClose"]["detail"];
+    arcgisConfirm: ArcgisPortalDeleteItems["arcgisConfirm"]["detail"];
+    arcgisError: ArcgisPortalDeleteItems["arcgisError"]["detail"];
+  };
+}
+
+/** @internal */
+export interface DeleteItemsPayload {
+  deletedItems: DeleteItemResponse[] | null;
+  permanentlyDeletedItems: DeleteItemResponse[] | null;
+  deprecatedItems: APIResponse[] | null;
+  /**
+   * Optional overrides for the number of items deleted.
+   * Needed if composite items are included for delete, because they are not part of the `/deleteItems` response
+   */
+  deletedItemsCount?: number;
+  permanentlyDeletedItemsCount?: number;
+}