feat(): adds entity discussion settings (#1221)

* feat(hub-common): adds discussion settings support for entities affects: @esri/hub-common * refactor(): returns buildUiSchema * feat(): control site disableDiscussions setting on entity * test(hub-common): update tests for discussions schema affects: @esri/hub-common * feat(hub-common): add discussion settings for isDiscussable affects: @esri/hub-common * refactor(hub-common): remove optional chaining affects: @esri/hub-common
Esri · Oct 2, 2023 · 5e25a43 · 5e25a43
1 parent 77a7f27
commit 5e25a43
Show file tree

Hide file tree

Showing 35 changed files with 450 additions and 85 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/common/src/content/_internal/ContentBusinessRules.ts b/packages/common/src/content/_internal/ContentBusinessRules.ts
@@ -21,6 +21,7 @@ export const ContentPermissions = [
   "hub:content:workspace:overview",
   "hub:content:workspace:dashboard",
   "hub:content:workspace:details",
+  "hub:content:workspace:discussion",
   "hub:content:workspace:settings",
   "hub:content:manage",
 ] as const;
@@ -67,6 +68,10 @@ export const ContentPermissionPolicies: IPermissionPolicy[] = [
     permission: "hub:content:workspace:details",
     dependencies: ["hub:content:edit"],
   },
+  {
+    permission: "hub:content:workspace:discussion",
+    dependencies: ["hub:content:edit"],
+  },
   {
     permission: "hub:content:workspace:settings",
     dependencies: ["hub:content:edit"],

diff --git a/packages/common/src/content/_internal/ContentSchema.ts b/packages/common/src/content/_internal/ContentSchema.ts
@@ -5,6 +5,7 @@ export type ContentEditorType = (typeof ContentEditorTypes)[number];
 export const ContentEditorTypes = [
   "hub:content:edit",
   "hub:content:settings",
+  "hub:content:discussions",
 ] as const;
 
 /**

diff --git a/packages/common/src/content/_internal/ContentUiSchemaDiscussions.ts b/packages/common/src/content/_internal/ContentUiSchemaDiscussions.ts
@@ -0,0 +1,44 @@
+import { IHubEditableContent } from "../../core/types";
+import { IArcGISContext } from "../../ArcGISContext";
+import { IUiSchema } from "../../core/schemas/types";
+
+/**
+ * @private
+ * settings uiSchema for Hub Discussions - this
+ * defines how the schema properties should be
+ * rendered in the Discussions settings experience
+ */
+export const buildUiSchema = async (
+  i18nScope: string,
+  entity: IHubEditableContent,
+  context: IArcGISContext
+): Promise<IUiSchema> => {
+  return {
+    type: "Layout",
+    elements: [
+      {
+        type: "Section",
+        labelKey: `${i18nScope}.sections.discussions.label`,
+        elements: [
+          {
+            labelKey: `${i18nScope}.fields.discussable.label`,
+            scope: "/properties/isDiscussable",
+            type: "Control",
+            options: {
+              control: "hub-field-input-radio",
+              labels: [
+                `{{${i18nScope}.fields.discussable.enabled.label:translate}}`,
+                `{{${i18nScope}.fields.discussable.disabled.label:translate}}`,
+              ],
+              descriptions: [
+                `{{${i18nScope}.fields.discussable.enabled.description:translate}}`,
+                `{{${i18nScope}.fields.discussable.disabled.description:translate}}`,
+              ],
+              icons: ["speech-bubbles", "circle-disallowed"],
+            },
+          },
+        ],
+      },
+    ],
+  };
+};
diff --git a/packages/common/src/content/_internal/computeProps.ts b/packages/common/src/content/_internal/computeProps.ts
@@ -10,6 +10,7 @@ import { getContentEditUrl, getHubRelativeUrl } from "./internalContentUtils";
 import { IHubLocation } from "../../core/types/IHubLocation";
 import { IHubEditableContent } from "../../core/types/IHubEditableContent";
 import { getRelativeWorkspaceUrl } from "../../core/getRelativeWorkspaceUrl";
+import { isDiscussable } from "../../discussions";
 import {
   hasServiceCapability,
   ServiceCapabilities,
@@ -72,6 +73,8 @@ export function computeProps(
         : deriveLocationFromItemExtent(model.item.extent);
   }
 
+  content.isDiscussable = isDiscussable(content);
+
   if (enrichments.server) {
     content.serverExtractCapability = hasServiceCapability(
       ServiceCapabilities.EXTRACT,

diff --git a/packages/common/src/content/edit.ts b/packages/common/src/content/edit.ts
@@ -19,6 +19,7 @@ import { getPropertyMap } from "./_internal/getPropertyMap";
 import { cloneObject } from "../util";
 import { IModel } from "../types";
 import { getProp } from "../objects/get-prop";
+import { setDiscussableKeyword } from "../discussions";
 import { modelToHubEditableContent } from "./fetch";
 import { getService, parseServiceUrl } from "@esri/arcgis-rest-feature-layer";
 import { updateServiceDefinition } from "@esri/arcgis-rest-service-admin";
@@ -58,6 +59,11 @@ export async function createContent(
   // this expansion solves the typing somehow
   const content = { /* ...DEFAULT_PROJECT, */ ...partialContent };
 
+  content.typeKeywords = setDiscussableKeyword(
+    content.typeKeywords,
+    content.isDiscussable
+  );
+
   // Map project object onto a default project Model
   const mapper = new PropertyMapper<Partial<IHubEditableContent>, IModel>(
     getPropertyMap()
@@ -103,6 +109,10 @@ export async function updateContent(
   // to properly handle other types like PDFs that don't have JSON data
   const item = await getItem(content.id, requestOptions);
   const model: IModel = { item };
+  content.typeKeywords = setDiscussableKeyword(
+    content.typeKeywords,
+    content.isDiscussable
+  );
   // create the PropertyMapper
   const mapper = new PropertyMapper<Partial<IHubEditableContent>, IModel>(
     getPropertyMap()

diff --git a/packages/common/src/core/schemas/internal/getEntityEditorSchemas.ts b/packages/common/src/core/schemas/internal/getEntityEditorSchemas.ts
@@ -57,6 +57,8 @@ export async function getEntityEditorSchemas(
           import("../../../sites/_internal/SiteUiSchemaCreate"),
         "hub:site:followers": () =>
           import("../../../sites/_internal/SiteUiSchemaFollowers"),
+        "hub:site:discussions": () =>
+          import("../../../sites/_internal/SiteUiSchemaDiscussions"),
       }[type as SiteEditorType]();
       uiSchema = await siteModule.buildUiSchema(
         i18nScope,
@@ -77,6 +79,8 @@ export async function getEntityEditorSchemas(
           import("../../../discussions/_internal/DiscussionUiSchemaEdit"),
         "hub:discussion:create": () =>
           import("../../../discussions/_internal/DiscussionUiSchemaCreate"),
+        "hub:discussion:settings": () =>
+          import("../../../discussions/_internal/DiscussionUiSchemaSettings"),
       }[type as DiscussionEditorType]();
       uiSchema = await discussionModule.buildUiSchema(
         i18nScope,
@@ -153,6 +157,8 @@ export async function getEntityEditorSchemas(
       const contentModule = await {
         "hub:content:edit": () =>
           import("../../../content/_internal/ContentUiSchemaEdit"),
+        "hub:content:discussions": () =>
+          import("../../../content/_internal/ContentUiSchemaDiscussions"),
         "hub:content:settings": () =>
           import("../../../content/_internal/ContentUiSchemaSettings"),
       }[type as ContentEditorType]();
@@ -174,6 +180,8 @@ export async function getEntityEditorSchemas(
           import("../../../groups/_internal/GroupUiSchemaEdit"),
         "hub:group:settings": () =>
           import("../../../groups/_internal/GroupUiSchemaSettings"),
+        "hub:group:discussions": () =>
+          import("../../../groups/_internal/GroupUiSchemaDiscussions"),
       }[type as GroupEditorType]();
       uiSchema = await groupModule.buildUiSchema(
         i18nScope,

diff --git a/packages/common/src/core/types/IHubGroup.ts b/packages/common/src/core/types/IHubGroup.ts
@@ -99,6 +99,11 @@ export interface IHubGroup extends IHubEntityBase, IWithPermissions {
    */
   tags?: string[];
 
+  /**
+   * System configurable typekeywords
+   */
+  typeKeywords?: string[];
+
   /**
    * Group thumbnail url (read-only)
    */

diff --git a/packages/common/src/core/types/IHubSite.ts b/packages/common/src/core/types/IHubSite.ts
@@ -81,4 +81,6 @@ export interface IHubSite
   legacyTeams: string[];
 }
 
-export type IHubSiteEditor = IHubItemEntityEditor<IHubSite> & {};
+export type IHubSiteEditor = IHubItemEntityEditor<IHubSite> & {
+  _discussions?: boolean;
+};
diff --git a/packages/common/src/discussions/_internal/DiscussionSchema.ts b/packages/common/src/discussions/_internal/DiscussionSchema.ts
@@ -5,6 +5,7 @@ export type DiscussionEditorType = (typeof DiscussionEditorTypes)[number];
 export const DiscussionEditorTypes = [
   "hub:discussion:edit",
   "hub:discussion:create",
+  "hub:discussion:settings",
 ] as const;
 
 /**

diff --git a/packages/common/src/discussions/_internal/DiscussionUiSchemaEdit.ts b/packages/common/src/discussions/_internal/DiscussionUiSchemaEdit.ts
@@ -182,29 +182,6 @@ export const buildUiSchema = async (
           },
         ],
       },
-      {
-        type: "Section",
-        labelKey: `${i18nScope}.sections.settings.label`,
-        elements: [
-          {
-            labelKey: `${i18nScope}.fields.discussable.label`,
-            scope: "/properties/isDiscussable",
-            type: "Control",
-            options: {
-              control: "hub-field-input-radio",
-              labels: [
-                `{{${i18nScope}.fields.discussable.enabled.label:translate}}`,
-                `{{${i18nScope}.fields.discussable.disabled.label:translate}}`,
-              ],
-              descriptions: [
-                `{{${i18nScope}.fields.discussable.enabled.description:translate}}`,
-                `{{${i18nScope}.fields.discussable.disabled.description:translate}}`,
-              ],
-              icons: ["speech-bubbles", "circle-disallowed"],
-            },
-          },
-        ],
-      },
     ],
   };
 };
diff --git a/packages/common/src/discussions/_internal/DiscussionUiSchemaSettings.ts b/packages/common/src/discussions/_internal/DiscussionUiSchemaSettings.ts
@@ -0,0 +1,44 @@
+import { IHubDiscussion } from "../../core/types";
+import { IArcGISContext } from "../../ArcGISContext";
+import { IUiSchema } from "../../core/schemas/types";
+
+/**
+ * @private
+ * settings uiSchema for Hub Discussions - this
+ * defines how the schema properties should be
+ * rendered in the Discussions settings experience
+ */
+export const buildUiSchema = async (
+  i18nScope: string,
+  entity: IHubDiscussion,
+  context: IArcGISContext
+): Promise<IUiSchema> => {
+  return {
+    type: "Layout",
+    elements: [
+      {
+        type: "Section",
+        labelKey: `${i18nScope}.sections.settings.label`,
+        elements: [
+          {
+            labelKey: `${i18nScope}.fields.discussable.label`,
+            scope: "/properties/isDiscussable",
+            type: "Control",
+            options: {
+              control: "hub-field-input-radio",
+              labels: [
+                `{{${i18nScope}.fields.discussable.enabled.label:translate}}`,
+                `{{${i18nScope}.fields.discussable.disabled.label:translate}}`,
+              ],
+              descriptions: [
+                `{{${i18nScope}.fields.discussable.enabled.description:translate}}`,
+                `{{${i18nScope}.fields.discussable.disabled.description:translate}}`,
+              ],
+              icons: ["speech-bubbles", "circle-disallowed"],
+            },
+          },
+        ],
+      },
+    ],
+  };
+};
diff --git a/packages/common/src/discussions/utils.ts b/packages/common/src/discussions/utils.ts
@@ -40,7 +40,7 @@ export function setDiscussableKeyword(
   typeKeywords: string[],
   discussable: boolean
 ): string[] {
-  const updatedTypeKeywords = typeKeywords.filter(
+  const updatedTypeKeywords = (typeKeywords || []).filter(
     (typeKeyword: string) => typeKeyword !== CANNOT_DISCUSS
   );
   if (!discussable) {