chore: rename isOwner to isGroupOwner and add comments

Esri · Aug 29, 2023 · 157939c · 157939c
1 parent 1667a23
commit 157939c
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 7 deletions.
diff --git a/packages/common/src/search/_internal/portalSearchGroupMembers.ts b/packages/common/src/search/_internal/portalSearchGroupMembers.ts
@@ -133,7 +133,7 @@ async function searchGroupMembers(
   // over the includes and requestOptions
   const fn = (member: IGroupMember) => {
     return memberToSearchResult(
-      { ...member, isOwner: resp.owner.username === member.username },
+      { ...member, isGroupOwner: resp.owner.username === member.username },
       searchOptions.include,
       searchOptions.requestOptions
     );
@@ -179,7 +179,7 @@ interface IGroupMember {
  * @returns
  */
 async function memberToSearchResult(
-  member: IGroupMember & { isOwner: boolean },
+  member: IGroupMember & { isGroupOwner: boolean },
   include: string[] = [],
   requestOptions?: IHubRequestOptions
 ): Promise<IHubSearchResult> {
@@ -199,7 +199,7 @@ async function memberToSearchResult(
     thumbnail: null,
     created: null,
     modified: null,
-    isOwner: member.isOwner,
+    isGroupOwner: member.isGroupOwner,
   };
 
   const fsGetUser = failSafe(getUser, user);

diff --git a/packages/common/src/users/HubUsers.ts b/packages/common/src/users/HubUsers.ts
@@ -26,6 +26,13 @@ export async function enrichUserSearchResult(
     access: user.access as AccessLevel,
     id: user.username,
     type: "User",
+    /**
+     * We need to return a valid IHubSearchResult, so we store
+     * IUser information where it makes the most sense - e.g.
+     * we store the user's full name under the "name" property,
+     * and since users don't have an owner, we fill that property
+     * with the user's username
+     */
     name: user.fullName,
     owner: user.username,
     // A private user will not have a description prop at all
@@ -42,10 +49,10 @@ export async function enrichUserSearchResult(
       thumbnail: null,
     },
   };
-  // Group Memberships need these properties
+  // Group Memberships need these additional properties
   if (user.memberType) {
     result.memberType = user.memberType;
-    result.isOwner = user.isOwner;
+    result.isGroupOwner = user.isGroupOwner;
   }
 
   // Informal Enrichments - basically adding type-specific props

diff --git a/packages/common/src/users/view.ts b/packages/common/src/users/view.ts
@@ -54,7 +54,7 @@ const getSharedUserCardModel = (user: IHubSearchResult): IHubCardViewModel => {
    * card
    */
   if (memberType) {
-    if (user.isOwner) {
+    if (user.isGroupOwner) {
       badges.push({
         icon: "user-key",
         color: "gray",

diff --git a/packages/common/test/users/view.test.ts b/packages/common/test/users/view.test.ts
@@ -61,7 +61,7 @@ describe("user view module:", () => {
     describe("membership badges", () => {
       it("adds an owner badge if the user is the group owner", () => {
         const GROUP_MEMBER_RESULT = cloneObject(USER_HUB_SEARCH_RESULT);
-        GROUP_MEMBER_RESULT.isOwner = true;
+        GROUP_MEMBER_RESULT.isGroupOwner = true;
         GROUP_MEMBER_RESULT.memberType = "admin";
 
         const result = userResultToCardModel(GROUP_MEMBER_RESULT);