chore: CollectionGroupMembership -> GroupMembership (outline#7269)

* chore: CollectionGroupMembership -> GroupMembership

* Backwards compat

* docs

Author: tommoor

app/components/GroupListItem.tsx

@@ -5,8 +5,8 @@ import { useTranslation } from "react-i18next";
 import styled from "styled-components";
 import { MAX_AVATAR_DISPLAY } from "@shared/constants";
 import { s } from "@shared/styles";
-import CollectionGroupMembership from "~/models/CollectionGroupMembership";
 import Group from "~/models/Group";
+import GroupMembership from "~/models/GroupMembership";
 import GroupMembers from "~/scenes/GroupMembers";
 import Facepile from "~/components/Facepile";
 import Flex from "~/components/Flex";
@@ -19,7 +19,7 @@ import NudeButton from "./NudeButton";
 
 type Props = {
   group: Group;
-  membership?: CollectionGroupMembership;
+  membership?: GroupMembership;
   showFacepile?: boolean;
   showAvatar?: boolean;
   renderActions: (params: { openMembersModal: () => void }) => React.ReactNode;

app/components/Sharing/Collection/CollectionMemberList.tsx

@@ -24,7 +24,7 @@ type Props = {
 };
 
 function CollectionMemberList({ collection, invitedInSession }: Props) {
-  const { memberships, collectionGroupMemberships } = useStores();
+  const { memberships, groupMemberships } = useStores();
   const can = usePolicy(collection);
   const { t } = useTranslation();
   const theme = useTheme();
@@ -39,8 +39,8 @@ function CollectionMemberList({ collection, invitedInSession }: Props) {
 
   const { request: fetchGroupMemberships } = useRequest(
     React.useCallback(
-      () => collectionGroupMemberships.fetchAll({ id: collectionId }),
-      [collectionGroupMemberships, collectionId]
+      () => groupMemberships.fetchAll({ id: collectionId }),
+      [groupMemberships, collectionId]
     )
   );
 
@@ -75,7 +75,7 @@ function CollectionMemberList({ collection, invitedInSession }: Props) {
 
   return (
     <>
-      {collectionGroupMemberships
+      {groupMemberships
         .inCollection(collection.id)
         .sort((a, b) =>
           (
@@ -103,12 +103,12 @@ function CollectionMemberList({ collection, invitedInSession }: Props) {
                     permission: CollectionPermission | typeof EmptySelectValue
                   ) => {
                     if (permission === EmptySelectValue) {
-                      await collectionGroupMemberships.delete({
+                      await groupMemberships.delete({
                         collectionId: collection.id,
                         groupId: membership.groupId,
                       });
                     } else {
-                      await collectionGroupMemberships.create({
+                      await groupMemberships.create({
                         collectionId: collection.id,
                         groupId: membership.groupId,
                         permission,

app/components/Sharing/Collection/SharePopover.tsx

@@ -44,8 +44,7 @@ type Props = {
 function SharePopover({ collection, visible, onRequestClose }: Props) {
   const theme = useTheme();
   const team = useCurrentTeam();
-  const { collectionGroupMemberships, users, groups, memberships } =
-    useStores();
+  const { groupMemberships, users, groups, memberships } = useStores();
   const { t } = useTranslation();
   const can = usePolicy(collection);
   const [query, setQuery] = React.useState("");
@@ -206,7 +205,7 @@ function SharePopover({ collection, visible, onRequestClose }: Props) {
               }
 
               if (group) {
-                await collectionGroupMemberships.create({
+                await groupMemberships.create({
                   collectionId: collection.id,
                   groupId: group.id,
                   permission: CollectionPermission.Read,
@@ -268,7 +267,7 @@ function SharePopover({ collection, visible, onRequestClose }: Props) {
       }),
     [
       collection.id,
-      collectionGroupMemberships,
+      groupMemberships,
       groups,
       hidePicker,
       memberships,

app/components/Sharing/components/Suggestions.tsx

@@ -122,6 +122,8 @@ export const Suggestions = observer(
       getSuggestionForEmail,
       users,
       users.orderedData,
+      groups,
+      groups.orderedData,
       document?.id,
       document?.members,
       collection?.id,

app/models/CollectionGroupMembership.ts

@@ -0,0 +1,41 @@
+import { observable } from "mobx";
+import { CollectionPermission, DocumentPermission } from "@shared/types";
+import Collection from "./Collection";
+import Document from "./Document";
+import Group from "./Group";
+import Model from "./base/Model";
+import Relation from "./decorators/Relation";
+
+/**
+ * Represents a groups's membership to a collection or document.
+ */
+class GroupMembership extends Model {
+  static modelName = "GroupMembership";
+
+  /** The group ID that this membership is granted to. */
+  groupId: string;
+
+  /** The group that this membership is granted to. */
+  @Relation(() => Group, { onDelete: "cascade" })
+  group: Group;
+
+  /** The document ID that this membership grants the group access to. */
+  documentId: string | undefined;
+
+  /** The document that this membership grants the group access to. */
+  @Relation(() => Document, { onDelete: "cascade" })
+  document: Document | undefined;
+
+  /** The collection ID that this membership grants the group access to. */
+  collectionId: string | undefined;
+
+  /** The collection that this membership grants the group access to. */
+  @Relation(() => Collection, { onDelete: "cascade" })
+  collection: Collection | undefined;
+
+  /** The permission level granted to the group. */
+  @observable
+  permission: CollectionPermission | DocumentPermission;
+}
+
+export default GroupMembership;

app/models/GroupMembership.ts

@@ -4,30 +4,22 @@ import Model from "./base/Model";
 import Relation from "./decorators/Relation";
 
 /**
- * Represents a user's membership in a group.
+ * Represents a user's membership to a group.
  */
 class GroupUser extends Model {
   static modelName = "GroupUser";
 
-  /**
-   * The ID of the user.
-   */
+  /** The ID of the user. */
   userId: string;
 
-  /**
-   * The user that belongs to the group.
-   */
+  /** The user that belongs to the group. */
   @Relation(() => User, { onDelete: "cascade" })
   user: User;
 
-  /**
-   * The ID of the group.
-   */
+  /** The ID of the group. */
   groupId: string;
 
-  /**
-   * The group that the user belongs to.
-   */
+  /** The group that the user belongs to. */
   @Relation(() => Group, { onDelete: "cascade" })
   group: Group;
 }

app/models/GroupUser.ts

@@ -19,32 +19,32 @@ class UserMembership extends Model {
   @observable
   permission: DocumentPermission;
 
-  /** The document ID that this permission grants the user access to. */
+  /** The document ID that this membership grants the user access to. */
   documentId?: string;
 
-  /** The document that this permission grants the user access to. */
+  /** The document that this membership grants the user access to. */
   @Relation(() => Document, { onDelete: "cascade" })
   document?: Document;
 
-  /** The source ID points to the root permission from which this permission inherits */
+  /** The source ID points to the root membership from which this inherits */
   sourceId?: string;
 
-  /** The source points to the root permission from which this permission inherits */
+  /** The source points to the root membership from which this inherits */
   @Relation(() => UserMembership, { onDelete: "cascade" })
   source?: UserMembership;
 
-  /** The user ID that this permission is granted to. */
+  /** The user ID that this membership is granted to. */
   userId: string;
 
-  /** The user that this permission is granted to. */
+  /** The user that this membership is granted to. */
   @Relation(() => User, { onDelete: "cascade" })
   user: User;
 
-  /** The user that created this permission. */
+  /** The user that created this membership. */
   @Relation(() => User, { onDelete: "null" })
   createdBy: User;
 
-  /** The user ID that created this permission. */
+  /** The user ID that created this membership. */
   createdById: string;
 
   store: UserMembershipsStore;

app/models/UserMembership.ts

@@ -25,7 +25,7 @@ const MembershipPreview = ({ collection, limit = 8 }: Props) => {
   const [usersCount, setUsersCount] = React.useState(0);
   const [groupsCount, setGroupsCount] = React.useState(0);
   const { t } = useTranslation();
-  const { memberships, collectionGroupMemberships, users } = useStores();
+  const { memberships, groupMemberships, users } = useStores();
   const collectionUsers = users.inCollection(collection.id);
   const context = useActionContext();
   const isMobile = useMobile();
@@ -44,7 +44,7 @@ const MembershipPreview = ({ collection, limit = 8 }: Props) => {
         };
         const [users, groups] = await Promise.all([
           memberships.fetchPage(options),
-          collectionGroupMemberships.fetchPage(options),
+          groupMemberships.fetchPage(options),
         ]);
         setUsersCount(users[PAGINATION_SYMBOL].total);
         setGroupsCount(groups[PAGINATION_SYMBOL].total);
@@ -58,7 +58,7 @@ const MembershipPreview = ({ collection, limit = 8 }: Props) => {
     isMobile,
     collection.permission,
     collection.id,
-    collectionGroupMemberships,
+    groupMemberships,
     memberships,
     limit,
   ]);