feat(hub-common): adds followers group discussion settings on site wo… (

#1251) * feat(hub-common): adds followers group discussion settings on site workspace affects: @esri/hub-common * chore(): lint * fix(hub-common): pR feedback affects: @esri/hub-common
Esri · Oct 8, 2023 · e0beb59 · e0beb59
1 parent 98c4545
commit e0beb59
Show file tree

Hide file tree

Showing 65 changed files with 317 additions and 210 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/common/e2e/associations.e2e.ts b/packages/common/e2e/associations.e2e.ts
@@ -8,7 +8,6 @@ import Artifactory from "./helpers/Artifactory";
 import config from "./helpers/config";
 import {
   ICreateOutput,
-  cleanupItems,
   createInitiative,
   createProjects,
   createScopeGroup,

diff --git a/packages/common/e2e/fixtures/initiative.ts b/packages/common/e2e/fixtures/initiative.ts
@@ -1,4 +1,4 @@
-import { IHubInitiative, IModel } from "../../src";
+import { IModel } from "../../src";
 
 const model: IModel = {
   item: {

diff --git a/packages/common/e2e/fixtures/project.ts b/packages/common/e2e/fixtures/project.ts
@@ -1,4 +1,4 @@
-import { IHubProject, IModel } from "../../src";
+import { IModel } from "../../src";
 
 const projectmodel: IModel = {
   item: {

diff --git a/packages/common/e2e/metrics.e2e.ts b/packages/common/e2e/metrics.e2e.ts
@@ -10,7 +10,6 @@ import Artifactory from "./helpers/Artifactory";
 import config from "./helpers/config";
 import {
   ICreateOutput,
-  cleanupItems,
   createInitiative,
   createProjects,
   createScopeGroup,

diff --git a/packages/common/e2e/permissions.e2e.ts b/packages/common/e2e/permissions.e2e.ts
@@ -1,8 +1,6 @@
 import { IArcGISContext } from "../src/ArcGISContext";
 import { fetchHubEntity } from "../src/core/fetchHubEntity";
 import { HubEntity } from "../src/core/types/HubEntity";
-import { IHubInitiative } from "../src/core/types/IHubInitiative";
-import { HubInitiative } from "../src/initiatives/HubInitiative";
 import { checkPermission } from "../src/permissions/checkPermission";
 import Artifactory from "./helpers/Artifactory";
 import config from "./helpers/config";

diff --git a/packages/common/e2e/purge-domains.e2e.ts b/packages/common/e2e/purge-domains.e2e.ts
@@ -3,13 +3,9 @@ import {
   lookupDomain,
   deleteSite,
   removeDomain,
-  batch,
   IArcGISContext,
   failSafe,
 } from "../src";
-import { hostnames } from "./fixtures/sample";
-import Artifactory from "./helpers/Artifactory";
-import config from "./helpers/config";
 let count = 0;
 async function processDomain(cfg: {
   domain: string;

diff --git a/packages/common/src/content/_internal/computeProps.ts b/packages/common/src/content/_internal/computeProps.ts
@@ -2,9 +2,8 @@ import { IRequestOptions } from "@esri/arcgis-rest-request";
 import { UserSession } from "@esri/arcgis-rest-auth";
 import { getItemThumbnailUrl } from "../../resources";
 import { IModel } from "../../types";
-import { bBoxToExtent, extentToPolygon, isBBox } from "../../extent";
+import { bBoxToExtent, isBBox } from "../../extent";
 import { IExtent } from "@esri/arcgis-rest-types";
-import Geometry = __esri.Geometry;
 import { getItemHomeUrl } from "../../urls/get-item-home-url";
 import { getContentEditUrl, getHubRelativeUrl } from "./internalContentUtils";
 import { IHubLocation } from "../../core/types/IHubLocation";

diff --git a/packages/common/src/content/search.ts b/packages/common/src/content/search.ts
@@ -1,5 +1,4 @@
 import { IItem } from "@esri/arcgis-rest-types";
-import { isMaster } from "cluster";
 import { fetchItemEnrichments } from "../items/_enrichments";
 import { getProp } from "../objects";
 import { getItemThumbnailUrl } from "../resources";

diff --git a/packages/common/src/core/EntityEditor.ts b/packages/common/src/core/EntityEditor.ts
@@ -10,7 +10,7 @@ import { HubSite } from "../sites/HubSite";
 import { HubTemplate } from "../templates";
 import { IEditorConfig, IWithEditorBehavior } from "./behaviors";
 import { getTypeFromEntity } from "./getTypeFromEntity";
-import { EditorType, UiSchemaElementOptions } from "./schemas";
+import { EditorType } from "./schemas";
 import { HubEntity } from "./types/HubEntity";
 import { HubEntityEditor, IEntityEditorContext } from "./types/HubEntityEditor";
 

diff --git a/packages/common/src/core/HubItemEntity.ts b/packages/common/src/core/HubItemEntity.ts
@@ -32,7 +32,7 @@ import {
 } from "./behaviors";
 
 import { IWithThumbnailBehavior } from "./behaviors/IWithThumbnailBehavior";
-import { AccessLevel, IHubItemEntity, SettableAccessLevel } from "./types";
+import { IHubItemEntity, SettableAccessLevel } from "./types";
 import { sharedWith } from "./_internal/sharedWith";
 import { IWithDiscussionsBehavior } from "./behaviors/IWithDiscussionsBehavior";
 import { setDiscussableKeyword } from "../discussions";
@@ -256,6 +256,25 @@ export abstract class HubItemEntity<T extends IHubItemEntity>
     });
   }
 
+  /**
+   * Sets whether or not the followers group is discussable
+   * @param isDiscussable
+   */
+  async setFollowersGroupIsDiscussable(isDiscussable: boolean) {
+    const group = await this.getFollowersGroup();
+    const typeKeywords = setDiscussableKeyword(
+      group.typeKeywords,
+      isDiscussable
+    );
+    await updateGroup({
+      group: {
+        id: group.id,
+        typeKeywords,
+      },
+      authentication: this.context.session,
+    });
+  }
+
   /**
    * Return a list of groups the Entity is shared to.
    * @returns

diff --git a/packages/common/src/core/behaviors/IWithEditorBehavior.ts b/packages/common/src/core/behaviors/IWithEditorBehavior.ts
@@ -1,9 +1,4 @@
-import {
-  IConfigurationSchema,
-  IUiSchema,
-  UiSchemaElementOptions,
-  EditorType,
-} from "../schemas";
+import { IConfigurationSchema, IUiSchema, EditorType } from "../schemas";
 import { HubEntity, HubEntityEditor, IEntityEditorContext } from "../types";
 
 export interface IEditorConfig {

diff --git a/packages/common/src/core/behaviors/IWithFollowersBehavior.ts b/packages/common/src/core/behaviors/IWithFollowersBehavior.ts
@@ -13,4 +13,8 @@ export interface IWithFollowersBehavior {
    * Set the access level of the followers group
    */
   setFollowersGroupAccess(access: SettableAccessLevel): Promise<void>;
+  /**
+   * Set whether or not the followers group is discussable
+   */
+  setFollowersGroupIsDiscussable(isDiscussable: boolean): Promise<void>;
 }
diff --git a/packages/common/src/core/behaviors/IWithSharingBehavior.ts b/packages/common/src/core/behaviors/IWithSharingBehavior.ts
@@ -1,4 +1,4 @@
-import { IGetItemGroupsResponse, IGroup } from "@esri/arcgis-rest-portal";
+import { IGroup } from "@esri/arcgis-rest-portal";
 import { AccessLevel } from "../types";
 
 /**

diff --git a/packages/common/src/core/schemas/internal/getCategoryItems.ts b/packages/common/src/core/schemas/internal/getCategoryItems.ts
@@ -1,6 +1,5 @@
 import { request } from "@esri/arcgis-rest-request";
 import { IHubRequestOptions } from "../../../types";
-import { HubEntity } from "../../types/HubEntity";
 import { IUiSchemaComboboxItem } from "../types";
 
 /**

diff --git a/packages/common/src/core/schemas/shared/HubItemEntitySchema.ts b/packages/common/src/core/schemas/shared/HubItemEntitySchema.ts
@@ -41,6 +41,7 @@ export const HubItemEntitySchema: IConfigurationSchema = {
           type: "boolean",
           default: true,
         },
+        isDiscussable: ENTITY_IS_DISCUSSABLE_SCHEMA,
       },
     },
     view: {

diff --git a/packages/common/src/core/traits/IWithMetrics.ts b/packages/common/src/core/traits/IWithMetrics.ts
@@ -1,4 +1,3 @@
-import { IReference } from "../types";
 import { IMetric } from "../types/Metrics";
 
 /**

diff --git a/packages/common/src/core/types/IAccessResponse.ts b/packages/common/src/core/types/IAccessResponse.ts
@@ -1,4 +1,3 @@
-import { IPolicyCheck } from "../../permissions/types/IPolicyCheck";
 import { PolicyResponse } from "../../permissions/types/PolicyResponse";
 
 export interface IAccessResponse {

diff --git a/packages/common/src/core/types/IHubInitiative.ts b/packages/common/src/core/types/IHubInitiative.ts
@@ -1,10 +1,4 @@
-import {
-  IWithSlug,
-  IWithLayout,
-  IWithPermissions,
-  IWithCatalog,
-} from "../traits";
-import {} from "../traits/IWithCatalog";
+import { IWithSlug, IWithPermissions, IWithCatalog } from "../traits";
 import { IWithMetrics } from "../traits/IWithMetrics";
 import { IHubItemEntity, IHubItemEntityEditor } from "./IHubItemEntity";
 

diff --git a/packages/common/src/core/types/IHubItemEntity.ts b/packages/common/src/core/types/IHubItemEntity.ts
@@ -150,5 +150,6 @@ export type IHubItemEntityEditor<T> = Omit<T, "extent"> & {
   _followers?: {
     groupAccess?: AccessLevel;
     showFollowAction?: boolean;
+    isDiscussable?: boolean;
   };
 };
diff --git a/packages/common/src/core/types/IHubProject.ts b/packages/common/src/core/types/IHubProject.ts
@@ -6,7 +6,6 @@ import {
   IWithCatalog,
 } from "../traits/index";
 import { IHubItemEntity, IHubItemEntityEditor } from "./IHubItemEntity";
-import { IExtent } from "@esri/arcgis-rest-feature-layer";
 
 /**
  * Defines the properties of a Hub Project object

diff --git a/packages/common/src/discussions/utils.ts b/packages/common/src/discussions/utils.ts
@@ -5,18 +5,9 @@ import {
   AclCategory,
   AclSubCategory,
   IChannel,
-  IChannelAclPermission,
   SharingAccess,
 } from "./api/types";
-import {
-  IFilter,
-  IHubSearchOptions,
-  IHubSearchResponse,
-  IHubSearchResult,
-  IPredicate,
-  IQuery,
-  hubSearch,
-} from "../search";
+import { IFilter, IPredicate, IQuery } from "../search";
 
 /**
  * Utility to determine if a given IGroup, IItem, IHubContent, or IHubItemEntity

diff --git a/packages/common/src/groups/addGroupMembers.ts b/packages/common/src/groups/addGroupMembers.ts
@@ -1,4 +1,3 @@
-import { IAuthenticationManager } from "@esri/arcgis-rest-request";
 import { IUser } from "@esri/arcgis-rest-types";
 import { failSafe } from "../utils";
 import { autoAddUsers } from "./autoAddUsers";

diff --git a/packages/common/src/metrics/resolveMetric.ts b/packages/common/src/metrics/resolveMetric.ts
@@ -14,7 +14,6 @@ import { getProp } from "../objects/get-prop";
 import { IPredicate, IQuery } from "../search/types/IHubCatalog";
 import { combineQueries } from "../search/_internal/combineQueries";
 import { IHubSearchOptions } from "../search/types/IHubSearchOptions";
-import { memoize } from "../utils/memoize";
 import { portalSearchItemsAsItems } from "../search/_internal/portalSearchItems";
 
 /**

diff --git a/packages/common/src/pages/HubPages.ts b/packages/common/src/pages/HubPages.ts
@@ -29,12 +29,7 @@ import { getPropertyMap } from "./_internal/getPropertyMap";
 import { computeProps } from "./_internal/computeProps";
 import { IUserRequestOptions } from "@esri/arcgis-rest-auth";
 import { IUserItemOptions, removeItem } from "@esri/arcgis-rest-portal";
-import {
-  DEFAULT_PAGE,
-  DEFAULT_PAGE_MODEL,
-  HUB_PAGE_ITEM_TYPE,
-  ENTERPRISE_PAGE_ITEM_TYPE,
-} from "./defaults";
+import { DEFAULT_PAGE, DEFAULT_PAGE_MODEL } from "./defaults";
 
 /**
  * @private

diff --git a/packages/common/src/pages/_internal/computeProps.ts b/packages/common/src/pages/_internal/computeProps.ts
@@ -7,7 +7,6 @@ import { processEntityFeatures } from "../../permissions/_internal/processEntity
 import { PageDefaultFeatures } from "./PageBusinessRules";
 import { getItemHomeUrl } from "../../urls/get-item-home-url";
 import { IHubPage } from "../../core/types/IHubPage";
-import { getHubRelativeUrl } from "../../content/_internal/internalContentUtils";
 import { getRelativeWorkspaceUrl } from "../../core/getRelativeWorkspaceUrl";
 
 /**

diff --git a/packages/common/src/projects/HubProject.ts b/packages/common/src/projects/HubProject.ts
@@ -32,7 +32,7 @@ import {
   IHubCardViewModel,
 } from "../core/types/IHubCardViewModel";
 import { projectToCardModel } from "./view";
-import { cloneObject, maybePush } from "../util";
+import { cloneObject } from "../util";
 import { createProject, editorToProject, updateProject } from "./edit";
 import { ProjectEditorType } from "./_internal/ProjectSchema";
 import { enrichEntity } from "../core/enrichEntity";

diff --git a/packages/common/src/search/_internal/explainPredicate.ts b/packages/common/src/search/_internal/explainPredicate.ts
@@ -1,6 +1,5 @@
 import { IRequestOptions } from "@esri/arcgis-rest-request";
 import { GenericResult, IPredicateExplanation } from "../explainQueryResult";
-import { cloneObject } from "../../util";
 import { IMatchOptions } from "../types";
 import {
   PREDICATE_DATE_PROPS,

diff --git a/packages/common/src/search/utils.ts b/packages/common/src/search/utils.ts
@@ -11,7 +11,6 @@ import {
 } from "@esri/arcgis-rest-portal";
 import { isPageType } from "../content/_internal/internalContentUtils";
 import { IHubSite } from "../core";
-import { getProp } from "../objects/get-prop";
 import { ISearchResponse } from "../types";
 import { cloneObject } from "../util";
 import { IHubSearchResult } from "./types";

diff --git a/packages/common/src/sites/HubSite.ts b/packages/common/src/sites/HubSite.ts
@@ -30,7 +30,6 @@ import { IContainsResponse, IDeepCatalogInfo, IHubCatalog } from "../search";
 import { deepContains } from "../core/_internal/deepContains";
 
 import {
-  applyVersion,
   createVersion,
   deleteVersion,
   getVersion,
@@ -47,7 +46,13 @@ import { cloneObject } from "../util";
 import { PropertyMapper } from "../core/_internal/PropertyMapper";
 import { getPropertyMap } from "./_internal/getPropertyMap";
 
-import { IHubSiteEditor, IModel, setProp, SettableAccessLevel } from "../index";
+import {
+  IHubSiteEditor,
+  IModel,
+  isDiscussable,
+  setProp,
+  SettableAccessLevel,
+} from "../index";
 import { SiteEditorType } from "./_internal/SiteSchema";
 
 /**
@@ -424,6 +429,9 @@ export class HubSite
       editor
     );
 
+    const followersGroup = await this.getFollowersGroup();
+    setProp("_followers.isDiscussable", isDiscussable(followersGroup), editor);
+
     editor._discussions = this.entity.features["hub:site:feature:discussions"];
 
     return editor;
@@ -458,6 +466,13 @@ export class HubSite
 
     delete editor._thumbnail;
 
+    // set whether or not the followers group is discussable
+    if (editor._followers?.isDiscussable !== undefined) {
+      await this.setFollowersGroupIsDiscussable(
+        editor._followers.isDiscussable
+      );
+    }
+
     // set the followers group access
     if (editor._followers?.groupAccess) {
       await this.setFollowersGroupAccess(

diff --git a/packages/common/src/sites/_internal/SiteUiSchemaFollowers.ts b/packages/common/src/sites/_internal/SiteUiSchemaFollowers.ts
@@ -56,6 +56,23 @@ export const buildUiSchema = async (
               },
             },
           },
+          {
+            labelKey: `${i18nScope}.fields.followers.discussable.label`,
+            scope: "/properties/_followers/properties/isDiscussable",
+            type: "Control",
+            options: {
+              control: "hub-field-input-radio",
+              labels: [
+                `{{${i18nScope}.fields.followers.discussable.enabled.label:translate}}`,
+                `{{${i18nScope}.fields.followers.discussable.disabled.label:translate}}`,
+              ],
+              descriptions: [
+                `{{${i18nScope}.fields.followers.discussable.enabled.description:translate}}`,
+                `{{${i18nScope}.fields.followers.discussable.disabled.description:translate}}`,
+              ],
+              icons: ["speech-bubbles", "circle-disallowed"],
+            },
+          },
         ],
       },
     ],

diff --git a/packages/common/src/sites/_internal/applyCatalogStructureMigration.ts b/packages/common/src/sites/_internal/applyCatalogStructureMigration.ts
@@ -1,4 +1,3 @@
-import { getProp } from "../../objects/get-prop";
 import { IHubCatalog } from "../../search/types/IHubCatalog";
 import { IModel } from "../../types";
 

diff --git a/packages/common/test/Hub.test.ts b/packages/common/test/Hub.test.ts
@@ -4,7 +4,7 @@ import { IUser } from "@esri/arcgis-rest-types";
 // imported with a full path
 import { ArcGISContextManager } from "../src/ArcGISContextManager";
 import { Hub } from "../src/Hub";
-import { IArcGISContextManagerOptions, IHubProject } from "../src";
+import { IArcGISContextManagerOptions } from "../src";
 import { MOCK_AUTH } from "./mocks/mock-auth";
 // import * as ProjectsModule from "../src/projects/HubProjects";
 

diff --git a/packages/common/test/content/_internal/internalContentUtils.test.ts b/packages/common/test/content/_internal/internalContentUtils.test.ts
@@ -1,6 +1,6 @@
 import { IItem } from "@esri/arcgis-rest-types";
 import { getContentEditUrl } from "../../../src/content/_internal/internalContentUtils";
-import { IHubRequestOptions, IModel } from "../../../src/types";
+import { IHubRequestOptions } from "../../../src/types";
 import { cloneObject } from "../../../src/util";
 import { MOCK_HUB_REQOPTS } from "../../mocks/mock-auth";
 

diff --git a/packages/common/test/content/index.test.ts b/packages/common/test/content/index.test.ts
@@ -4,7 +4,6 @@ import {
   cloneObject,
   enrichContentSearchResult,
   IHubRequestOptions,
-  IHubSearchResult,
 } from "../../src";
 import * as FetchEnrichments from "../../src/items/_enrichments";