feat: site's followers pane permissions (#1186)

- adds a new IWithFollowers trait with a followersGroupId property for entities to extend if they support followers - adds business rules for site's followers pane
Esri · Aug 24, 2023 · 90feec7 · 90feec7
1 parent 7ae927a
commit 90feec7
Show file tree

Hide file tree

Showing 4 changed files with 43 additions and 1 deletion.
diff --git a/packages/common/src/core/traits/IWithFollowers.ts b/packages/common/src/core/traits/IWithFollowers.ts
@@ -0,0 +1,7 @@
+/**
+ * properties for entities with followers
+ */
+export interface IWithFollowers {
+  /** followers group id */
+  followersGroupId: string;
+}
diff --git a/packages/common/src/core/types/IHubSite.ts b/packages/common/src/core/types/IHubSite.ts
@@ -7,6 +7,7 @@ import {
   IWithSlug,
 } from "../traits/index";
 import { IHubItemEntity } from "./IHubItemEntity";
+import { IWithFollowers } from "../traits/IWithFollowers";
 
 /**
  * DRAFT: Under development and more properties will likely be added
@@ -18,7 +19,8 @@ export interface IHubSite
     IWithCatalog,
     IWithLayout,
     IWithPermissions,
-    IWithVersioningBehavior {
+    IWithVersioningBehavior,
+    IWithFollowers {
   /**
    * Array of minimal page objects
    */

diff --git a/packages/common/src/sites/_internal/SiteBusinessRules.ts b/packages/common/src/sites/_internal/SiteBusinessRules.ts
@@ -30,6 +30,9 @@ export const SitePermissions = [
   "hub:site:workspace:collaborators",
   "hub:site:workspace:content",
   "hub:site:workspace:metrics",
+  "hub:site:workspace:followers",
+  "hub:site:workspace:followers:member",
+  "hub:site:workspace:followers:manager",
 ] as const;
 
 /**
@@ -107,6 +110,32 @@ export const SitesPermissionPolicies: IPermissionPolicy[] = [
     dependencies: ["hub:site:edit"],
     environments: ["devext", "qaext"],
   },
+  {
+    permission: "hub:site:workspace:followers",
+    dependencies: ["hub:site:edit"],
+  },
+  {
+    permission: "hub:site:workspace:followers:member",
+    dependencies: ["hub:site:workspace:followers"],
+    assertions: [
+      {
+        property: "context:currentUser",
+        type: "is-group-member",
+        value: "entity:followersGroupId",
+      },
+    ],
+  },
+  {
+    permission: "hub:site:workspace:followers:manager",
+    dependencies: ["hub:site:workspace:followers"],
+    assertions: [
+      {
+        property: "context:currentUser",
+        type: "is-group-admin",
+        value: "entity:followersGroupId",
+      },
+    ],
+  },
 ];
 
 /**

diff --git a/packages/common/src/sites/_internal/getPropertyMap.ts b/packages/common/src/sites/_internal/getPropertyMap.ts
@@ -37,6 +37,10 @@ export function getPropertyMap(): IPropertyMap[] {
     entityKey: "slug",
     storeKey: "item.properties.slug",
   });
+  map.push({
+    entityKey: "followersGroupId",
+    storeKey: "item.properties.followersGroupId",
+  });
   map.push({
     entityKey: "legacyCapabilities",
     storeKey: "data.values.capabilities",