mirror of
https://github.com/outline/outline.git
synced 2026-11-21 21:44:30 +03:00
* Add description column to groups
- Add database migration to add description column to groups table
- Update server-side Group model with description field and validation
- Update group presenter to include description in API responses
- Update API schemas to validate description field in create/update operations
- Update client-side Group model with description field and search integration
- Update unfurl types and presenter to include description for hover cards
- Update HoverPreviewGroup component to display description in UI
The description field is optional with a 2000 character limit and is included
in group search functionality.
* Fix TypeScript error: Add missing description prop to HoverPreviewGroup
The HoverPreviewGroup component expects a description prop but it wasn't being passed from HoverPreview.tsx. This was causing the types check to fail with:
error TS2741: Property 'description' is missing in type '{ ref: MutableRefObject<HTMLDivElement | null>; name: any; memberCount: any; users: any; }' but required in type 'Props'.
Fixed by adding the description prop from data.description which is available in the UnfurlResponse[UnfurlResourceType.Group] type.
* Move 2000 char validation to shared constant
- Add GroupValidation.maxDescriptionLength constant to shared/validations.ts
- Update server Group model to use GroupValidation.maxDescriptionLength
- Update API schemas to use the shared constant instead of hardcoded value
- Ensures consistent validation across the entire application
* Add description field to CreateGroupDialog and EditGroupDialog
- Add description textarea input to both create and edit group dialogs
- Import GroupValidation constant for consistent character limit validation
- Set maxLength to GroupValidation.maxDescriptionLength (2000 chars)
- Include description in form submission for both create and update operations
- Add placeholder text for better UX
- Maintain backward compatibility with optional description field
* Add description column to GroupsTable
- Add description column between name and members columns
- Display group description with fallback to em dash (—) for empty descriptions
- Use secondary text styling for consistent visual hierarchy
- Set column width to 2fr for adequate space
- Maintain sortable functionality through accessor
* tweaks
* animation
---------
Co-authored-by: codegen-sh[bot] <131295404+codegen-sh[bot]@users.noreply.github.com>
Co-authored-by: Tom Moor <tom@getoutline.com>
93 lines
2.3 KiB
TypeScript
93 lines
2.3 KiB
TypeScript
import { computed, observable } from "mobx";
|
|
import GroupMembership from "./GroupMembership";
|
|
import Model from "./base/Model";
|
|
import Field from "./decorators/Field";
|
|
import { GroupPermission } from "@shared/types";
|
|
import { Searchable } from "./interfaces/Searchable";
|
|
|
|
class Group extends Model implements Searchable {
|
|
static modelName = "Group";
|
|
|
|
@Field
|
|
@observable
|
|
name: string;
|
|
|
|
@Field
|
|
@observable
|
|
description: string;
|
|
|
|
@observable
|
|
externalId: string | undefined;
|
|
|
|
@observable
|
|
memberCount: number;
|
|
|
|
@Field
|
|
@observable
|
|
disableMentions: boolean;
|
|
|
|
/**
|
|
* Returns the users that are members of this group.
|
|
*/
|
|
@computed
|
|
get users() {
|
|
const { users } = this.store.rootStore;
|
|
return users.inGroup(this.id);
|
|
}
|
|
|
|
@computed
|
|
get searchContent(): string[] {
|
|
return [this.name, this.description].filter(Boolean);
|
|
}
|
|
|
|
@computed
|
|
get searchSuppressed(): boolean {
|
|
return this.disableMentions;
|
|
}
|
|
|
|
@computed
|
|
get admins() {
|
|
const { groupUsers } = this.store.rootStore;
|
|
return groupUsers.orderedData
|
|
.filter(
|
|
(groupUser) =>
|
|
groupUser.groupId === this.id &&
|
|
groupUser.permission === GroupPermission.Admin
|
|
)
|
|
.map((groupUser) => groupUser.user);
|
|
}
|
|
|
|
/**
|
|
* Returns the direct memberships that this group has to documents. Documents that the current
|
|
* user already has access to through a collection, archived, and trashed documents are not included.
|
|
*
|
|
* @returns A list of group memberships
|
|
*/
|
|
@computed
|
|
get documentMemberships(): GroupMembership[] {
|
|
const { groupMemberships, groupUsers, documents, policies, auth } =
|
|
this.store.rootStore;
|
|
|
|
return groupMemberships.orderedData
|
|
.filter((groupMembership) =>
|
|
groupUsers.orderedData.some(
|
|
(groupUser) =>
|
|
groupUser.groupId === groupMembership.groupId &&
|
|
groupUser.userId === auth.user?.id
|
|
)
|
|
)
|
|
.filter(
|
|
(m) => m.groupId === this.id && m.sourceId === null && m.documentId
|
|
)
|
|
.filter((m) => {
|
|
const document = documents.get(m.documentId!);
|
|
const policy = document?.collectionId
|
|
? policies.get(document.collectionId)
|
|
: undefined;
|
|
return !policy?.abilities?.readDocument && !!document?.isActive;
|
|
});
|
|
}
|
|
}
|
|
|
|
export default Group;
|