@arcgis/portal-components 5.2.0-next.12 → 5.2.0-next.121

package/dist/components/arcgis-portal-group-browser/index.d.ts

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

package/dist/components/arcgis-portal-group-browser/index.js

@@ -0,0 +1,6 @@
+import "../arcgis-portal-browser-top-bar/index.js";
+import "../arcgis-portal-browser-search/index.js";
+import "../arcgis-portal-group-card/index.js";
+import "../arcgis-portal-browser/index.js";
+import "../arcgis-portal-group-browser-preview/index.js";
+export * from "./customElement.js";

package/dist/components/arcgis-portal-group-browser/types.d.ts

@@ -0,0 +1,225 @@
+import type PortalGroup from "@arcgis/core/portal/PortalGroup.js";
+import type { SearchResult } from "../../types/search.js";
+import type { PortalBrowserSortField, PortalBrowserSortOrder } from "../arcgis-portal-browser-sort/utils.js";
+import type { BrowserPageDetail } from "../arcgis-portal-browser/utils/types.js";
+import type { PortalGroupCardProps } from "../arcgis-portal-group-card/customElement.js";
+
+export interface PortalGroupBrowserSearchParamInteraction {
+  read?: boolean;
+  write?: boolean;
+}
+
+export interface PortalGroupBrowserSearchParamsUpdate {
+  phase: PortalGroupBrowserSearchParamsUpdatePhase;
+  search: string;
+  searchParams: URLSearchParams;
+  searchParamMap: PortalGroupBrowserOwnedSearchParamMap;
+}
+
+export interface PortalGroupBrowserFiltersConfig {
+  created?: GroupFilterConfig<PortalGroupBrowserDateFilterProps>;
+  modified?: GroupFilterConfig<PortalGroupBrowserDateFilterProps>;
+  owner?: GroupFilterConfig<PortalGroupBrowserOwnerFilterProps>;
+  membership?: GroupFilterConfig<PortalGroupBrowserMembershipFilterProps>;
+  memberOrg?: GroupFilterConfig<PortalGroupBrowserMemberOrgFilterProps>;
+  specialGroups?: GroupFilterConfig<PortalGroupBrowserSpecialGroupsFilterProps>;
+  access?: GroupFilterConfig<PortalGroupBrowserAccessFilterProps>;
+  groupsByUser?: GroupFilterConfig<PortalGroupBrowserGroupsByUserFilterProps>;
+}
+
+export interface PortalGroupBrowserSortConfig {
+  enabled: boolean;
+  props?: PortalGroupBrowserSortProps;
+}
+
+export interface PortalGroupBrowserQuery extends PortalGroupBrowserSortDetail, BrowserPageDetail {
+  searchTerm?: string;
+  searchUser?: string;
+  baseQuery?: string;
+  filters?: GroupBrowserFilterSet;
+}
+
+export type PortalGroupBrowserGroupCardConfig = Omit<PortalGroupCardProps, "view">;
+
+export interface PortalGroupBrowserCardsConfig {
+  group?: (group: PortalGroup) => PortalGroupBrowserGroupCardConfig;
+}
+
+export interface PortalGroupBrowserSearchResult extends SearchResult<PortalGroup> {
+  queryParams?: PortalGroupBrowserQueryParams;
+}
+
+export interface PortalGroupBrowserResponse extends PortalGroupBrowserSortDetail {
+  queryResponse: PortalGroupBrowserSearchResult;
+  selectedGroups: PortalGroup[];
+  searchTerm: string;
+  filters?: GroupBrowserFilterSet;
+  searchParamMap: PortalGroupBrowserOwnedSearchParamMap;
+}
+
+export interface PortalGroupBrowserOwnedSearchParamMap {
+  access?: PortalGroupBrowserAccess;
+  created?: PortalGroupBrowserDateRange;
+  createdFrom?: number;
+  createdTo?: number;
+  memberOrgIds?: PortalGroupBrowserMemberOrg;
+  membershipAccess?: PortalGroupBrowserMembership;
+  modified?: PortalGroupBrowserDateRange;
+  modifiedFrom?: number;
+  modifiedTo?: number;
+  num?: number;
+  owner?: PortalGroupBrowserOwner;
+  q?: string;
+  searchTerm?: string;
+  sortField?: PortalBrowserSortField;
+  sortOrder?: PortalBrowserSortOrder;
+  specialGroups?: PortalGroupBrowserSpecialGroups;
+  start?: number;
+}
+
+export type PortalGroupBrowserSearchParamsUpdatePhase = "hydrate" | "write";
+
+export interface PortalGroupBrowserSortProps extends BaseFilterProps {
+  options?: PortalBrowserSortField[];
+  field?: PortalBrowserSortField;
+  order?: PortalBrowserSortOrder;
+  appearance?: "accordion" | "dropdown";
+  showText?: boolean;
+  useDeleted?: boolean;
+}
+
+export type GroupBrowserFilterSet = {
+  created?: GroupBrowserDateDetail;
+  modified?: GroupBrowserDateDetail;
+  owner?: GroupBrowserOwnerDetail;
+  membership?: GroupBrowserMembershipDetail;
+  memberOrg?: GroupBrowserMemberOrgDetail;
+  specialGroups?: GroupBrowserSpecialGroupsDetail;
+  access?: GroupBrowserAccessDetail;
+};
+
+export interface BaseFilterProps {
+  expanded?: boolean;
+}
+
+export interface GroupFilterConfig<TProps extends BaseFilterProps> {
+  enabled: boolean;
+  props?: TProps;
+}
+
+export type PortalGroupBrowserDateFilterProps = BaseFilterProps
+  & Partial<PortalGroupBrowserDateFilterSharedProps & PortalGroupBrowserDateSelection>;
+
+export type PortalGroupBrowserOwnerFilterProps = BaseFilterProps
+  & Partial<PortalGroupBrowserOwnerSelection>;
+
+export type PortalGroupBrowserMembershipFilterProps = BaseFilterProps
+  & Partial<PortalGroupBrowserMembershipSelection>;
+
+export type PortalGroupBrowserMemberOrgFilterProps = BaseFilterProps
+  & Partial<PortalGroupBrowserMemberOrgSelection>;
+
+export type PortalGroupBrowserSpecialGroupsFilterProps = BaseFilterProps
+  & Partial<PortalGroupBrowserSpecialGroupsSelection>;
+
+export type PortalGroupBrowserAccessFilterProps = BaseFilterProps
+  & Partial<PortalGroupBrowserAccessSelection>;
+
+export interface PortalGroupBrowserGroupsByUserFilterProps extends BaseFilterProps {
+  usernames?: string[];
+  selectedUsername?: string;
+}
+
+export interface PortalGroupBrowserSortDetail {
+  sortField?: PortalBrowserSortField;
+  sortOrder?: PortalBrowserSortOrder;
+}
+
+export interface PortalGroupBrowserQueryParams {
+  num?: number;
+  q?: string;
+  searchUserAccess?: string;
+  searchUserName?: string;
+  sortField?: PortalGroupBrowserQuery["sortField"];
+  sortOrder?: PortalGroupBrowserQuery["sortOrder"];
+  start?: number;
+}
+
+export type PortalGroupBrowserOwner = "inOrg" | "outsideOrg" | "owner";
+
+export type PortalGroupBrowserMembership = "anyOrg" | "collaboration" | "org";
+
+export type PortalGroupBrowserMemberOrg = "anotherOrg" | "myOrg";
+
+export type PortalGroupBrowserSpecialGroups = "admin" | "distributed" | "openData" | "settings" | "sharedUpdate";
+
+export type PortalGroupBrowserAccess = "org" | "private" | "public";
+
+export type PortalGroupBrowserDateRange = "custom" | "last7" | "last30" | "never" | "today" | "yesterday";
+
+export interface PortalGroupBrowserDateSelection {
+  range: PortalGroupBrowserDateRange | null;
+  start: Date | number | string | null;
+  end: Date | number | string | null;
+}
+
+export interface PortalGroupBrowserOwnerSelection {
+  owner: PortalGroupBrowserOwner | null;
+  username: string | null;
+}
+
+export interface PortalGroupBrowserMembershipSelection {
+  membership: PortalGroupBrowserMembership | null;
+}
+
+export interface PortalGroupBrowserMemberOrgSelection {
+  memberOrg: PortalGroupBrowserMemberOrg | null;
+  orgId: string;
+}
+
+export interface PortalGroupBrowserSpecialGroupsSelection {
+  specialGroup: PortalGroupBrowserSpecialGroups | null;
+}
+
+export interface PortalGroupBrowserAccessSelection {
+  access: PortalGroupBrowserAccess | null;
+}
+
+export interface GroupBrowserDateDetail extends GroupBrowserFilterDetail, PortalGroupBrowserDateSelection {
+  id: "created" | "modified";
+}
+
+export interface GroupBrowserOwnerDetail extends GroupBrowserFilterDetail, PortalGroupBrowserOwnerSelection {
+  id: "owner";
+}
+
+export interface GroupBrowserMembershipDetail extends GroupBrowserFilterDetail, PortalGroupBrowserMembershipSelection {
+  id: "membership";
+}
+
+export interface GroupBrowserMemberOrgDetail extends GroupBrowserFilterDetail, PortalGroupBrowserMemberOrgSelection {
+  id: "memberOrg";
+}
+
+export interface GroupBrowserSpecialGroupsDetail extends GroupBrowserFilterDetail, PortalGroupBrowserSpecialGroupsSelection {
+  id: "specialGroups";
+}
+
+export interface GroupBrowserAccessDetail extends GroupBrowserFilterDetail, PortalGroupBrowserAccessSelection {
+  id: "access";
+}
+
+export interface PortalGroupBrowserDateFilterSharedProps {
+  includeNever?: boolean;
+  serverProperty?: string;
+}
+
+export interface GroupBrowserFilterDetail {
+  id: PortalGroupBrowserFilterId;
+  param: string;
+  value: string;
+  label: string;
+  additionalParams?: string;
+}
+
+export type PortalGroupBrowserFilterId = "access" | "created" | "memberOrg" | "membership" | "modified" | "owner" | "specialGroups";

package/dist/components/arcgis-portal-group-browser-card/customElement.d.ts

@@ -0,0 +1,30 @@
+/// <reference path="../../index.d.ts" />
+import type PortalGroup from "@arcgis/core/portal/PortalGroup.js";
+import type { PublicLitElement as LitElement } from "@arcgis/lumina";
+import type { ArcgisPortalGroupBrowser } from "../arcgis-portal-group-browser/customElement.js";
+import type { PortalGroupBrowserGroupCardConfig } from "../arcgis-portal-group-browser/types.js";
+import type { PortalGroupCardPreviewDetail, PortalGroupCardSelectDetail } from "../arcgis-portal-group-card/types.js";
+
+/**
+ * A wrapper card for custom group-browser rendering that inherits state from the nearest `arcgis-portal-group-browser`.
+ *
+ * @slot [content-top]
+ * @slot [content-end]
+ * @slot [actions-start]
+ * @slot [actions-end]
+ */
+export abstract class ArcgisPortalGroupBrowserCard extends LitElement {
+  /** Optional browser reference override. Falls back to nearest parent group browser. */
+  accessor browser: ArcgisPortalGroupBrowser | undefined;
+  /** Optional card prop overrides forwarded to `arcgis-portal-group-card`. */
+  accessor cardProps: PortalGroupBrowserGroupCardConfig;
+  /** Group for this card row. */
+  accessor group: PortalGroup;
+  restoreFocus(): Promise<void>;
+  readonly arcgisGroupBrowserCardPreview: import("@arcgis/lumina").TargetedEvent<this, PortalGroupCardPreviewDetail>;
+  readonly arcgisGroupCardSelect: import("@arcgis/lumina").TargetedEvent<this, PortalGroupCardSelectDetail>;
+  readonly "@eventTypes": {
+    arcgisGroupBrowserCardPreview: ArcgisPortalGroupBrowserCard["arcgisGroupBrowserCardPreview"]["detail"];
+    arcgisGroupCardSelect: ArcgisPortalGroupBrowserCard["arcgisGroupCardSelect"]["detail"];
+  };
+}

package/dist/components/arcgis-portal-group-browser-card/customElement.js

@@ -0,0 +1,41 @@
+/* COPYRIGHT Esri - https://js.arcgis.com/5.2/LICENSE.txt */
+import { c as i } from "../../chunks/runtime.js";
+import { html as d } from "lit";
+import { LitElement as l, createEvent as a } from "@arcgis/lumina";
+import "../arcgis-portal-group-card/customElement.js";
+class n extends l {
+  constructor() {
+    super(...arguments), this.cardProps = {}, this.arcgisGroupCardSelect = a(), this.arcgisGroupBrowserCardPreview = a();
+  }
+  static {
+    this.properties = { group: 0, browser: 0, cardProps: 0 };
+  }
+  async restoreFocus() {
+    await this.renderRoot.querySelector("arcgis-portal-group-card")?.restoreFocus?.();
+  }
+  getBrowser() {
+    const r = this.el.closest("arcgis-portal-group-browser");
+    return this.browser ?? r;
+  }
+  isSelected(r, t) {
+    if (!r)
+      return !1;
+    const e = t.selectedGroupsState;
+    return Array.isArray(e) && e.some(({ id: o }) => o === r);
+  }
+  render() {
+    const r = this.getBrowser(), t = this.group;
+    if (!r || !t)
+      return;
+    const e = this.cardProps, o = r.store.view ?? "list";
+    return d`<arcgis-portal-group-card .portal=${r.portal} .group=${t} .user=${e.user} .indeterminate=${e.indeterminate} .view=${o} .selection=${r.selection} .selected=${e.selected ?? this.isSelected(t.id, r)} .preview=${e.preview ?? r.preview} .previewed=${e.previewed ?? r.previewedGroupId === t.id} .name=${e.name} .showSummary=${e.showSummary ?? !0} .hideBadges=${e.hideBadges ?? !1} .hideDateUpdated=${e.hideDateUpdated ?? !1} .showDateCreated=${e.showDateCreated ?? !1} .hideViewableBy=${e.hideViewableBy ?? !1} .hideOwner=${e.hideOwner ?? !1} .link=${e.link} .linkHandler=${e.linkHandler} .newTab=${e.newTab ?? !1} .disabled=${e.disabled ?? !1} @arcgisGroupCardSelect=${(s) => {
+      s.stopPropagation(), this.arcgisGroupCardSelect.emit(s.detail);
+    }} @arcgisGroupBrowserCardPreview=${(s) => {
+      s.stopPropagation(), this.arcgisGroupBrowserCardPreview.emit(s.detail);
+    }}><slot name=content-top slot=content-top></slot><div slot=content-end><slot name=content-end></slot></div><slot name=actions-start slot=actions-start></slot><slot name=actions-end slot=actions-end></slot></arcgis-portal-group-card>`;
+  }
+}
+i("arcgis-portal-group-browser-card", n);
+export {
+  n as ArcgisPortalGroupBrowserCard
+};

package/dist/components/arcgis-portal-group-browser-card/index.d.ts

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

package/dist/components/arcgis-portal-group-browser-card/index.js

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

package/dist/components/arcgis-portal-group-browser-preview/customElement.d.ts

@@ -0,0 +1,223 @@
+/// <reference path="../../index.d.ts" />
+import type Portal from "@arcgis/core/portal/Portal.js";
+import type PortalGroup from "@arcgis/core/portal/PortalGroup.js";
+import type PortalUser from "@arcgis/core/portal/PortalUser.js";
+import type { PublicLitElement as LitElement } from "@arcgis/lumina";
+import type { InternalUIAction } from "../../types/tracking.js";
+import type { PortalGroupBrowserSearchResult } from "../arcgis-portal-group-browser/types.js";
+import type { T9nMeta } from "@arcgis/lumina/controllers";
+
+export abstract class ArcgisPortalGroupBrowserPreview extends LitElement {
+  /** Current query response used for telemetry position calculation. */
+  accessor currentResponse: PortalGroupBrowserSearchResult | undefined;
+  /** Group selected for preview. */
+  accessor group: PortalGroup;
+  /**
+   * Hide group badges in overview section.
+   *
+   * @default false
+   */
+  accessor hideBadges: boolean;
+  /**
+   * Hide footer details action.
+   *
+   * @default false
+   */
+  accessor hidePreviewFooter: boolean;
+  /** @internal */
+  protected messages: {
+      browser: {
+          pageRange: string;
+          pageRangeAria: string;
+      };
+      filters: { title: string; };
+      groupsByUser: {
+          title: string;
+          me: string;
+      };
+      owner: {
+          title: string;
+          label: string;
+          owner: string;
+          inOrg: string;
+          outsideOrg: string;
+          someoneElse: string;
+      };
+      membership: {
+          title: string;
+          label: string;
+          org: string;
+          collaboration: string;
+          anyOrg: string;
+      };
+      memberOrg: {
+          title: string;
+          label: string;
+          myOrg: string;
+          anotherOrg: string;
+      };
+      specialGroups: {
+          title: string;
+          label: string;
+          openData: string;
+          sharedUpdate: string;
+          distributed: string;
+          admin: string;
+          settings: string;
+      };
+      access: {
+          title: string;
+          label: string;
+          public: string;
+          org: string;
+          private: string;
+      };
+      preview: {
+          titleFallback: string;
+          loading: string;
+          close: string;
+          ownedBy: string;
+          overview: string;
+          noSummary: string;
+          description: string;
+          noDescription: string;
+          content: string;
+          noContent: string;
+          viewContent: string;
+          groupManagers: string;
+          groupOwner: string;
+          noManagers: string;
+          openMembers: string;
+          settings: string;
+          viewableBy: string;
+          contributors: string;
+          joinMethod: string;
+          openSettings: string;
+          everyone: string;
+          onlyMembers: string;
+          onlyOrganization: string;
+          onlyOrganizationAndPartners: string;
+          onlyOwnerManager: string;
+          allMembers: string;
+          byAutojoin: string;
+          byInvitation: string;
+          byEnterprise: string;
+          byRequest: string;
+          access: string;
+          groupTags: string;
+          openGroupPage: string;
+          unknownValue: string;
+      };
+      content: {
+          noResults: string;
+          noContent: string;
+          loading: string;
+      };
+  } & T9nMeta<{
+      browser: {
+          pageRange: string;
+          pageRangeAria: string;
+      };
+      filters: { title: string; };
+      groupsByUser: {
+          title: string;
+          me: string;
+      };
+      owner: {
+          title: string;
+          label: string;
+          owner: string;
+          inOrg: string;
+          outsideOrg: string;
+          someoneElse: string;
+      };
+      membership: {
+          title: string;
+          label: string;
+          org: string;
+          collaboration: string;
+          anyOrg: string;
+      };
+      memberOrg: {
+          title: string;
+          label: string;
+          myOrg: string;
+          anotherOrg: string;
+      };
+      specialGroups: {
+          title: string;
+          label: string;
+          openData: string;
+          sharedUpdate: string;
+          distributed: string;
+          admin: string;
+          settings: string;
+      };
+      access: {
+          title: string;
+          label: string;
+          public: string;
+          org: string;
+          private: string;
+      };
+      preview: {
+          titleFallback: string;
+          loading: string;
+          close: string;
+          ownedBy: string;
+          overview: string;
+          noSummary: string;
+          description: string;
+          noDescription: string;
+          content: string;
+          noContent: string;
+          viewContent: string;
+          groupManagers: string;
+          groupOwner: string;
+          noManagers: string;
+          openMembers: string;
+          settings: string;
+          viewableBy: string;
+          contributors: string;
+          joinMethod: string;
+          openSettings: string;
+          everyone: string;
+          onlyMembers: string;
+          onlyOrganization: string;
+          onlyOrganizationAndPartners: string;
+          onlyOwnerManager: string;
+          allMembers: string;
+          byAutojoin: string;
+          byInvitation: string;
+          byEnterprise: string;
+          byRequest: string;
+          access: string;
+          groupTags: string;
+          openGroupPage: string;
+          unknownValue: string;
+      };
+      content: {
+          noResults: string;
+          noContent: string;
+          loading: string;
+      };
+  }>;
+  /** Portal used for thumbnail and deep-link resolution. */
+  accessor portal: Portal;
+  /**
+   * Apply spacing between footer actions.
+   *
+   * @default false
+   */
+  accessor previewFooterActionsSpaced: boolean;
+  /** Current signed-in user context used by preview cards. */
+  accessor user: PortalUser | undefined;
+  setFocus(): Promise<void>;
+  /** Fires on internal component interaction for telemetry. */
+  readonly arcgisGroupBrowserInternalUIAction: import("@arcgis/lumina").TargetedEvent<this, InternalUIAction>;
+  readonly arcgisGroupBrowserPreviewClose: import("@arcgis/lumina").TargetedEvent<this, void>;
+  readonly "@eventTypes": {
+    arcgisGroupBrowserInternalUIAction: ArcgisPortalGroupBrowserPreview["arcgisGroupBrowserInternalUIAction"]["detail"];
+    arcgisGroupBrowserPreviewClose: ArcgisPortalGroupBrowserPreview["arcgisGroupBrowserPreviewClose"]["detail"];
+  };
+}