@arcgis/portal-components 5.2.0-next.8 → 5.2.0-next.85

package/dist/components/arcgis-portal-item-actions/customElement.d.ts

@@ -0,0 +1,74 @@
+/// <reference path="../../index.d.ts" />
+import type Portal from "@arcgis/core/portal/Portal.js";
+import type PortalItem from "@arcgis/core/portal/PortalItem.js";
+import type PortalUser from "@arcgis/core/portal/PortalUser.js";
+import type { PublicLitElement as LitElement } from "@arcgis/lumina";
+import type { FavoriteUpdate } from "../arcgis-portal-item-favorite/utils.js";
+import type { T9nMeta } from "@arcgis/lumina/controllers";
+import type { Dropdown as Dropdown } from "@esri/calcite-components/components/calcite-dropdown";
+
+/** Configurable overflow menu for an item. */
+export abstract class ArcgisPortalItemActions extends LitElement {
+  /** Optional actions to render in the menu. */
+  accessor actions: PortalItemAction[];
+  /** Partial item JSON from search results or a loaded PortalItem instance. */
+  accessor item: PortalItem;
+  /** Optional keyboard handler for the trigger action. */
+  accessor keyHandler: ((e: KeyboardEvent, dropdown: Dropdown) => void) | undefined;
+  /** The more options text used by assistive technology. */
+  accessor label: string;
+  /** @internal */
+  protected messages: {
+      add: string;
+      remove: string;
+  } & T9nMeta<{
+      add: string;
+      remove: string;
+  }>;
+  /** Current Portal instance. */
+  accessor portal: Portal;
+  /** Text for the preview option. */
+  accessor previewText: string | undefined;
+  /**
+   * Allow the user to add and remove from favorites.
+   *
+   * @default false
+   */
+  accessor showFavorite: boolean;
+  /**
+   * Allow the user to open preview from the actions menu.
+   *
+   * @default false
+   */
+  accessor showPreview: boolean;
+  accessor tabIndexOverride: number | undefined;
+  /** Currently signed-in Portal user. */
+  accessor user: PortalUser | undefined;
+  setFocus(): Promise<void>;
+  /** Fires when user clicks an action. */
+  readonly arcgisItemActionClick: import("@arcgis/lumina").TargetedEvent<this, string>;
+  /** Legacy passthrough event retained for compatibility. */
+  readonly arcgisItemActions: import("@arcgis/lumina").TargetedEvent<this, unknown>;
+  /** Fires when user opens the action menu. */
+  readonly arcgisItemActionsOpen: import("@arcgis/lumina").TargetedEvent<this, PortalItemActionsOpenDetail>;
+  /** Fires when user changes the favorite status. */
+  readonly arcgisItemFavoriteUpdate: import("@arcgis/lumina").TargetedEvent<this, FavoriteUpdate>;
+  readonly "@eventTypes": {
+    arcgisItemActionClick: ArcgisPortalItemActions["arcgisItemActionClick"]["detail"];
+    arcgisItemActions: ArcgisPortalItemActions["arcgisItemActions"]["detail"];
+    arcgisItemActionsOpen: ArcgisPortalItemActions["arcgisItemActionsOpen"]["detail"];
+    arcgisItemFavoriteUpdate: ArcgisPortalItemActions["arcgisItemFavoriteUpdate"]["detail"];
+  };
+}
+
+export interface PortalItemAction {
+  action?: () => void;
+  id?: string;
+  link?: string;
+  newTab?: boolean;
+  text: string;
+}
+
+export interface PortalItemActionsOpenDetail {
+  el: Element | HTMLButtonElement;
+}

package/dist/components/arcgis-portal-item-actions/customElement.js

@@ -0,0 +1,89 @@
+/* COPYRIGHT Esri - https://js.arcgis.com/5.2/LICENSE.txt */
+import { c as w } from "../../chunks/runtime.js";
+import { repeat as f } from "lit/directives/repeat.js";
+import { keyed as p } from "lit/directives/keyed.js";
+import { LitElement as u, createEvent as l, nothing as a } from "@arcgis/lumina";
+import { css as g, html as h } from "lit";
+import { createRef as m, ref as v } from "lit/directives/ref.js";
+import { u as F } from "../../chunks/useT9n.js";
+import { t as $ } from "../../chunks/functionalities.js";
+import { g as I, i as b, t as y } from "../../chunks/utils.js";
+const k = g`:host{display:inline-flex}.screen-readers-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);white-space:nowrap;border-width:0}`;
+class x extends u {
+  constructor() {
+    super(), this.messages = F({ name: "portal-item-favorite", blocking: !0 }), this.actionRef = m(), this.dropdownRef = m(), this.favoriteRequestId = 0, this.didWarnEmptyActions = !1, this.handleFavoriteUpdate = (e) => {
+      const i = I(e, this.item.id ?? void 0);
+      i && (this.isFavorite = i.favorite);
+    }, this.isFavorite = !1, this.actions = [], this.showFavorite = !1, this.showPreview = !1, this.arcgisItemActionClick = l(), this.arcgisItemActionsOpen = l(), this.arcgisItemFavoriteUpdate = l(), this.arcgisItemActions = l(), this.listenOn(window, "arcgisItemFavoriteUpdate", this.handleFavoriteUpdate);
+  }
+  static {
+    this.properties = { isFavorite: 16, item: 0, portal: 0, user: 0, actions: 0, keyHandler: 0, label: 1, showFavorite: 5, showPreview: 5, previewText: 1, tabIndexOverride: 9 };
+  }
+  static {
+    this.styles = k;
+  }
+  async setFocus() {
+    await this.actionRef.value?.setFocus();
+  }
+  willUpdate(e) {
+    (e.has("item") || e.has("portal") || e.has("user")) && this.refreshFavorite();
+  }
+  async refreshFavorite() {
+    if (!this.item.id || !this.portal || !this.user) {
+      this.isFavorite = !1;
+      return;
+    }
+    const e = ++this.favoriteRequestId, i = await b(this.item.id, this.portal, this.user);
+    e === this.favoriteRequestId && (this.isFavorite = i);
+  }
+  async handleToggleFavorite(e) {
+    e.preventDefault(), e.stopPropagation();
+    const { item: i, portal: n, user: c, isFavorite: o } = this;
+    if (!i.id || !n || !c)
+      return;
+    const r = {
+      id: i.id,
+      access: i.access
+    }, { updated: s } = await y({
+      currentFavorite: o,
+      item: r,
+      portal: n,
+      user: c
+    });
+    s && (await $(300), this.isFavorite = !o, this.arcgisItemFavoriteUpdate.emit({
+      id: i.id,
+      favorite: this.isFavorite
+    }));
+  }
+  handleActionClick(e, i) {
+    i.stopPropagation(), this.arcgisItemActionClick.emit(e.id || e.text), e.action && (i.preventDefault(), e.action());
+  }
+  render() {
+    const { item: e, actions: i, label: n, previewText: c } = this, o = i.length > 0, r = this.showFavorite && !!this.user;
+    if (!o && !r && !this.showPreview && !this.didWarnEmptyActions && (console.warn("[arcgis-portal-item-actions] The actions menu is hidden because no actions were provided and both showFavorite/showPreview are disabled."), this.didWarnEmptyActions = !0), !o && !r && !this.showPreview)
+      return null;
+    const s = `${e.id}-title`;
+    return h`<span class="screen-readers-only" id=${s ?? a}>${e.title}</span><calcite-dropdown overlay-positioning=fixed placement=bottom-end close-on-select-disabled @click=${(t) => {
+      t.stopPropagation();
+    }} ${v(this.dropdownRef)}><calcite-action scale=s slot=trigger alignment=center .text=${n} icon=ellipsis tabindex=${this.tabIndexOverride ?? a} @click=${(t) => {
+      this.arcgisItemActionsOpen.emit({
+        el: t.currentTarget
+      });
+    }} @keydown=${(t) => {
+      const d = this.dropdownRef.value;
+      this.keyHandler && d && this.keyHandler(t, d);
+    }} ${v(this.actionRef)}></calcite-action><calcite-dropdown-group selection-mode=none>${f(i, (t) => t.id || t.text, (t) => h`<calcite-dropdown-item aria-describedby=${s ?? a} .href=${t.link} .target=${t.newTab ? "_blank" : void 0} .rel=${t.newTab ? "noopener noreferrer" : void 0} .innerHTML=${t.text ?? ""} @calciteDropdownItemSelect=${(d) => {
+      this.handleActionClick(t, d);
+    }}></calcite-dropdown-item>`)}${r && p("favorites", h`<calcite-dropdown-item aria-describedby=${s ?? a} @calciteDropdownItemSelect=${(t) => {
+      this.handleToggleFavorite(t);
+    }} @click=${(t) => {
+      t.preventDefault(), t.stopPropagation();
+    }}>${this.isFavorite ? this.messages.remove : this.messages.add}</calcite-dropdown-item>`) || ""}${this.showPreview && p("preview", h`<calcite-dropdown-item id=item-preview aria-describedby=${s ?? a} @calciteDropdownItemSelect=${(t) => {
+      t.stopPropagation(), this.arcgisItemActionClick.emit("preview");
+    }}>${c}</calcite-dropdown-item>`) || ""}</calcite-dropdown-group></calcite-dropdown>`;
+  }
+}
+w("arcgis-portal-item-actions", x);
+export {
+  x as ArcgisPortalItemActions
+};

package/dist/components/arcgis-portal-item-actions/index.d.ts

@@ -0,0 +1 @@
+export * from "./customElement.js";

package/dist/components/arcgis-portal-item-actions/index.js

@@ -0,0 +1,5 @@
+import "@esri/calcite-components/components/calcite-dropdown";
+import "@esri/calcite-components/components/calcite-action";
+import "@esri/calcite-components/components/calcite-dropdown-group";
+import "@esri/calcite-components/components/calcite-dropdown-item";
+export * from "./customElement.js";

package/dist/components/arcgis-portal-item-badge/customElement.d.ts

@@ -0,0 +1,260 @@
+/// <reference path="../../index.d.ts" />
+import type Portal from "@arcgis/core/portal/Portal.js";
+import type PortalItem from "@arcgis/core/portal/PortalItem.js";
+import type PortalUser from "@arcgis/core/portal/PortalUser.js";
+import type { PublicLitElement as LitElement } from "@arcgis/lumina";
+import type { ItemBadge } from "../arcgis-portal-item-badges/types.js";
+import type { T9nMeta } from "@arcgis/lumina/controllers";
+import type { Chip as Chip } from "@esri/calcite-components/components/calcite-chip";
+
+export abstract class ArcgisPortalItemBadge extends LitElement {
+  /** @internal */
+  protected _messages: {
+      Authoritative: {
+          title: string;
+          tooltip: {
+              org: string;
+              public: string;
+          };
+      };
+      Beta: {
+          title: string;
+          tooltip: string;
+      };
+      Deprecated: {
+          title: string;
+          tooltip: string;
+      };
+      "Has Replacement": {
+          title: string;
+          tooltip: string;
+          itemPageTooltip: string;
+          link: string;
+      };
+      DeprecatedItemType: {
+          title: string;
+          tooltip: {
+              general: string;
+              webAppBuilder: string;
+          };
+      };
+      "Living Atlas": {
+          title: string;
+          tooltip: string;
+      };
+      Subscriber: {
+          title: string;
+          tooltip: {
+              org: string;
+              public: string;
+          };
+      };
+      Premium: {
+          title: string;
+          tooltip: {
+              org: string;
+              public: string;
+          };
+      };
+      "Open Data": {
+          title: string;
+          tooltip: string;
+      };
+      Marketplace: {
+          title: string;
+          tooltip: string;
+      };
+      Collaboration: {
+          title: string;
+          tooltip: string;
+      };
+      Retired: {
+          title: string;
+          tooltip: {
+              general: string;
+              classicStoryMap: string;
+              classicStoryMapGeneric: string;
+              cityEngine: string;
+              app: string;
+              webAppBuilder: string;
+              bdfs: string;
+          };
+      };
+      "Public Data Collection": {
+          title: string;
+          tooltip: string;
+      };
+      Solution: {
+          title: string;
+          tooltip: string;
+      };
+      Registered: {
+          title: string;
+          tooltip: {
+              online: string;
+              enterprise: string;
+          };
+      };
+      "Registered API Key Credentials (Standard)": {
+          title: {
+              online: string;
+              enterprise: string;
+          };
+          tooltip: string;
+      };
+      "Registered API Key Credentials (Personal)": {
+          title: string;
+          tooltip: string;
+      };
+      "Registered OAuth 2.0 Credentials (Standard)": {
+          title: {
+              online: string;
+              enterprise: string;
+          };
+          tooltip: string;
+      };
+      "Registered OAuth 2.0 Credentials (Personal)": {
+          title: string;
+          tooltip: string;
+      };
+      "Registered Application": {
+          title: string;
+          tooltip: string;
+      };
+      "Personal credential": {
+          title: string;
+          tooltip: string;
+      };
+      loading: string;
+  } & T9nMeta<{
+      Authoritative: {
+          title: string;
+          tooltip: {
+              org: string;
+              public: string;
+          };
+      };
+      Beta: {
+          title: string;
+          tooltip: string;
+      };
+      Deprecated: {
+          title: string;
+          tooltip: string;
+      };
+      "Has Replacement": {
+          title: string;
+          tooltip: string;
+          itemPageTooltip: string;
+          link: string;
+      };
+      DeprecatedItemType: {
+          title: string;
+          tooltip: {
+              general: string;
+              webAppBuilder: string;
+          };
+      };
+      "Living Atlas": {
+          title: string;
+          tooltip: string;
+      };
+      Subscriber: {
+          title: string;
+          tooltip: {
+              org: string;
+              public: string;
+          };
+      };
+      Premium: {
+          title: string;
+          tooltip: {
+              org: string;
+              public: string;
+          };
+      };
+      "Open Data": {
+          title: string;
+          tooltip: string;
+      };
+      Marketplace: {
+          title: string;
+          tooltip: string;
+      };
+      Collaboration: {
+          title: string;
+          tooltip: string;
+      };
+      Retired: {
+          title: string;
+          tooltip: {
+              general: string;
+              classicStoryMap: string;
+              classicStoryMapGeneric: string;
+              cityEngine: string;
+              app: string;
+              webAppBuilder: string;
+              bdfs: string;
+          };
+      };
+      "Public Data Collection": {
+          title: string;
+          tooltip: string;
+      };
+      Solution: {
+          title: string;
+          tooltip: string;
+      };
+      Registered: {
+          title: string;
+          tooltip: {
+              online: string;
+              enterprise: string;
+          };
+      };
+      "Registered API Key Credentials (Standard)": {
+          title: {
+              online: string;
+              enterprise: string;
+          };
+          tooltip: string;
+      };
+      "Registered API Key Credentials (Personal)": {
+          title: string;
+          tooltip: string;
+      };
+      "Registered OAuth 2.0 Credentials (Standard)": {
+          title: {
+              online: string;
+              enterprise: string;
+          };
+          tooltip: string;
+      };
+      "Registered OAuth 2.0 Credentials (Personal)": {
+          title: string;
+          tooltip: string;
+      };
+      "Registered Application": {
+          title: string;
+          tooltip: string;
+      };
+      "Personal credential": {
+          title: string;
+          tooltip: string;
+      };
+      loading: string;
+  }>;
+  accessor appearance: Chip["appearance"] | undefined;
+  accessor badgeType: ItemBadge;
+  accessor item: PortalItem;
+  accessor portal: Portal;
+  /** @default "m" */
+  accessor scale: Chip["scale"];
+  /** @default false */
+  accessor showTooltip: boolean;
+  /** @default false */
+  accessor useProduction: boolean | undefined;
+  accessor user: PortalUser | undefined;
+  /** @default "full" */
+  accessor width: "full" | "narrow";
+}

package/dist/components/arcgis-portal-item-badge/customElement.js

@@ -0,0 +1,9 @@
+/* COPYRIGHT Esri - https://js.arcgis.com/5.2/LICENSE.txt */
+import "../../chunks/runtime.js";
+import "@arcgis/lumina";
+import "lit";
+import "../../chunks/useT9n.js";
+import { A as a } from "../../chunks/portal-item-badge.js";
+export {
+  a as ArcgisPortalItemBadge
+};

package/dist/components/arcgis-portal-item-badge/index.d.ts

@@ -0,0 +1 @@
+export * from "./customElement.js";

package/dist/components/arcgis-portal-item-badge/index.js

@@ -0,0 +1,5 @@
+import "@esri/calcite-components/components/calcite-chip";
+import "@esri/calcite-components/components/calcite-tooltip";
+import "@esri/calcite-components/components/calcite-loader";
+import "@esri/calcite-components/components/calcite-link";
+export * from "./customElement.js";

package/dist/components/arcgis-portal-item-badges/customElement.d.ts

@@ -0,0 +1,48 @@
+/// <reference path="../../index.d.ts" />
+import type Portal from "@arcgis/core/portal/Portal.js";
+import type PortalItem from "@arcgis/core/portal/PortalItem.js";
+import type PortalUser from "@arcgis/core/portal/PortalUser.js";
+import type { PublicLitElement as LitElement } from "@arcgis/lumina";
+import type { Chip as Chip } from "@esri/calcite-components/components/calcite-chip";
+
+/** Derives and renders portal item badges that represent status, capabilities, and lifecycle states. */
+export abstract class ArcgisPortalItemBadges extends LitElement {
+  /** Appearance of the chips used for item badges. */
+  accessor appearance: Chip["appearance"] | undefined;
+  /**
+   * Reflected flag that indicates no badges were generated for the current input.
+   *
+   * @default false
+   */
+  accessor empty: boolean;
+  /** Portal item to inspect for badges. */
+  accessor item: PortalItem;
+  /** Portal instance used for organization and environment-specific badge behavior. */
+  accessor portal: Portal;
+  /**
+   * Size of each badge chip.
+   *
+   * @default "m"
+   */
+  accessor scale: Chip["scale"];
+  /**
+   * Enables tooltip text for each badge.
+   *
+   * @default false
+   */
+  accessor showTooltips: boolean;
+  /**
+   * Optional mode for enterprise contexts that should resolve online tooltip content.
+   *
+   * @default false
+   */
+  accessor useProduction: boolean | undefined;
+  /** Optional current user, used for user-dependent badge logic. */
+  accessor user: PortalUser | undefined;
+  /**
+   * Full width shows label text, narrow renders icon only.
+   *
+   * @default "full"
+   */
+  accessor width: "full" | "narrow";
+}

package/dist/components/arcgis-portal-item-badges/customElement.js

@@ -0,0 +1,35 @@
+/* COPYRIGHT Esri - https://js.arcgis.com/5.2/LICENSE.txt */
+import { c as o } from "../../chunks/runtime.js";
+import { LitElement as l } from "@arcgis/lumina";
+import { css as p, html as m } from "lit";
+import { g as h } from "../../chunks/portal-item-badge.js";
+const d = p`:host{display:flex;flex-wrap:wrap;align-items:center}.portal-item-badges__badge{display:inline-block;margin-inline-end:.25rem}.portal-item-badges__badge:last-of-type{margin-inline-end:0}`;
+class n extends l {
+  constructor() {
+    super(...arguments), this.badges = [], this.width = "full", this.scale = "m", this.showTooltips = !1, this.empty = !1;
+  }
+  static {
+    this.properties = { badges: 16, item: 0, portal: 0, user: 0, width: 1, appearance: 1, scale: 1, showTooltips: 5, useProduction: 5, empty: 7 };
+  }
+  static {
+    this.styles = d;
+  }
+  willUpdate(t) {
+    if (t.has("item") || t.has("portal") || t.has("user")) {
+      if (!this.item || !this.portal) {
+        this.badges = [], this.empty = !0;
+        return;
+      }
+      const s = h(this.item, this.portal, this.user);
+      this.badges = s, this.empty = s.length === 0;
+    }
+  }
+  render() {
+    const { appearance: t, badges: s, scale: e, showTooltips: i, width: a } = this;
+    return s.map((r) => m`<arcgis-portal-item-badge .appearance=${t} .badgeType=${r} class="portal-item-badges__badge" .item=${this.item} .portal=${this.portal} .user=${this.user} .scale=${e} .showTooltip=${i} .useProduction=${this.useProduction} .width=${a}></arcgis-portal-item-badge>`);
+  }
+}
+o("arcgis-portal-item-badges", n);
+export {
+  n as ArcgisPortalItemBadges
+};

package/dist/components/arcgis-portal-item-badges/index.d.ts

@@ -0,0 +1 @@
+export * from "./customElement.js";

package/dist/components/arcgis-portal-item-badges/index.js

@@ -0,0 +1,2 @@
+import "../arcgis-portal-item-badge/index.js";
+export * from "./customElement.js";

package/dist/components/arcgis-portal-item-badges/types.d.ts

@@ -0,0 +1 @@
+export type ItemBadge = "Authoritative" | "Beta" | "Collaboration" | "Deprecated" | "DeprecatedItemType" | "Has Replacement" | "Living Atlas" | "Marketplace" | "Open Data" | "Personal credential" | "Premium" | "Public Data Collection" | "Registered API Key Credentials (Personal)" | "Registered API Key Credentials (Standard)" | "Registered Application" | "Registered OAuth 2.0 Credentials (Personal)" | "Registered OAuth 2.0 Credentials (Standard)" | "Registered" | "Retired" | "Solution" | "Subscriber";