mirror of
https://github.com/outline/outline.git
synced 2026-11-22 14:01:41 +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>
115 lines
2.6 KiB
TypeScript
115 lines
2.6 KiB
TypeScript
import { InferAttributes, InferCreationAttributes, Op } from "sequelize";
|
|
import {
|
|
BelongsTo,
|
|
Column,
|
|
ForeignKey,
|
|
Table,
|
|
HasMany,
|
|
BelongsToMany,
|
|
DataType,
|
|
Scopes,
|
|
} from "sequelize-typescript";
|
|
import { GroupValidation } from "@shared/validations";
|
|
import GroupMembership from "./GroupMembership";
|
|
import GroupUser from "./GroupUser";
|
|
import Team from "./Team";
|
|
import User from "./User";
|
|
import ParanoidModel from "./base/ParanoidModel";
|
|
import { CounterCache } from "./decorators/CounterCache";
|
|
import Fix from "./decorators/Fix";
|
|
import Length from "./validators/Length";
|
|
import NotContainsUrl from "./validators/NotContainsUrl";
|
|
|
|
@Scopes(() => ({
|
|
withMembership: (userId: string) => ({
|
|
include: [
|
|
{
|
|
association: "groupUsers",
|
|
required: true,
|
|
where: {
|
|
userId,
|
|
},
|
|
},
|
|
],
|
|
}),
|
|
}))
|
|
@Table({
|
|
tableName: "groups",
|
|
modelName: "group",
|
|
validate: {
|
|
async isUniqueNameInTeam() {
|
|
const foundItem = await Group.findOne({
|
|
where: {
|
|
teamId: this.teamId,
|
|
name: {
|
|
[Op.iLike]: this.name,
|
|
},
|
|
id: {
|
|
[Op.not]: this.id,
|
|
},
|
|
},
|
|
});
|
|
|
|
if (foundItem) {
|
|
throw new Error("The name of this group is already in use");
|
|
}
|
|
},
|
|
},
|
|
})
|
|
@Fix
|
|
class Group extends ParanoidModel<
|
|
InferAttributes<Group>,
|
|
Partial<InferCreationAttributes<Group>>
|
|
> {
|
|
@Length({ min: 0, max: 255, msg: "name must be be 255 characters or less" })
|
|
@NotContainsUrl
|
|
@Column
|
|
name: string;
|
|
|
|
@Length({ min: 0, max: GroupValidation.maxDescriptionLength, msg: `description must be ${GroupValidation.maxDescriptionLength} characters or less` })
|
|
@Column(DataType.TEXT)
|
|
description: string;
|
|
|
|
@Column
|
|
externalId: string;
|
|
|
|
@Column(DataType.BOOLEAN)
|
|
disableMentions: boolean;
|
|
|
|
static filterByMember(userId: string | undefined) {
|
|
return userId
|
|
? this.scope({ method: ["withMembership", userId] })
|
|
: this.scope("defaultScope");
|
|
}
|
|
|
|
// associations
|
|
|
|
@HasMany(() => GroupUser, "groupId")
|
|
groupUsers: GroupUser[];
|
|
|
|
@HasMany(() => GroupMembership, "groupId")
|
|
groupMemberships: GroupMembership[];
|
|
|
|
@BelongsTo(() => Team, "teamId")
|
|
team: Team;
|
|
|
|
@ForeignKey(() => Team)
|
|
@Column(DataType.UUID)
|
|
teamId: string;
|
|
|
|
@BelongsTo(() => User, "createdById")
|
|
createdBy: User;
|
|
|
|
@ForeignKey(() => User)
|
|
@Column(DataType.UUID)
|
|
createdById: string;
|
|
|
|
@BelongsToMany(() => User, () => GroupUser)
|
|
users: User[];
|
|
|
|
@CounterCache(() => GroupUser, { as: "members", foreignKey: "groupId" })
|
|
memberCount: Promise<number>;
|
|
}
|
|
|
|
export default Group;
|