Skip to content

armgit / plane

Public Imported from GitHub
0

πŸ”₯πŸ”₯πŸ”₯ Open-source Jira, Linear, Monday, and ClickUp alternative. Plane is a modern project management platform to manage tasks, sprints, docs, and triage.

improvement: enhance activity components and types modularity (#6262)

Prateek Shourya6070ed4d36d4
diff --git a/packages/types/src/activity.d.ts b/packages/types/src/activity.d.ts
new file mode 100644
index 0000000000..98d54dabc4
--- /dev/null
+++ b/packages/types/src/activity.d.ts
@@ -0,0 +1,36 @@
+export type TBaseActivity<
+ TFieldKey extends string = string,
+ TVerbKey extends string = string,
+> = {
+ id: string;
+ field: TFieldKey | undefined;
+ epoch: number;
+ verb: TVerbKey;
+ comment: string | undefined;
+ // updates
+ old_value: string | undefined;
+ new_value: string | undefined;
+ old_identifier: string | undefined;
+ new_identifier: string | undefined;
+ // actor detail
+ actor: string;
+ // timestamp
+ created_at: string;
+ updated_at: string;
+};
+
+export type TWorkspaceBaseActivity<
+ K extends string = string,
+ V extends string = string,
+> = TBaseActivity<K, V> & {
+ workspace: string;
+};
+
+export type TProjectBaseActivity<
+ K extends string = string,
+ V extends string = string,
+> = TWorkspaceBaseActivity<K, V> & {
+ project: string;
+};
+
+export type TBaseActivityVerbs = "created" | "updated" | "deleted";
diff --git a/packages/types/src/enums.ts b/packages/types/src/enums.ts
index 92de9a7405..854c0c6140 100644
--- a/packages/types/src/enums.ts
+++ b/packages/types/src/enums.ts
@@ -4,10 +4,7 @@ export enum EUserPermissions {
GUEST = 5,
}
-export type TUserPermissions =
- | EUserPermissions.ADMIN
- | EUserPermissions.MEMBER
- | EUserPermissions.GUEST;
+export type TUserPermissions = EUserPermissions.ADMIN | EUserPermissions.MEMBER | EUserPermissions.GUEST;
// project pages
export enum EPageAccess {
@@ -62,4 +59,5 @@ export enum EFileAssetType {
TEAM_SPACE_DESCRIPTION = "TEAM_SPACE_DESCRIPTION",
INITIATIVE_DESCRIPTION = "INITIATIVE_DESCRIPTION",
PROJECT_DESCRIPTION = "PROJECT_DESCRIPTION",
+ TEAM_SPACE_COMMENT_DESCRIPTION = "TEAM_SPACE_COMMENT_DESCRIPTION",
}
diff --git a/packages/types/src/index.d.ts b/packages/types/src/index.d.ts
index fa4bf05a8a..43cc3084a3 100644
--- a/packages/types/src/index.d.ts
+++ b/packages/types/src/index.d.ts
@@ -35,3 +35,4 @@ export * from "./file";
export * from "./workspace-draft-issues/base";
export * from "./command-palette";
export * from "./timezone";
+export * from "./activity";
diff --git a/web/ce/types/projects/project-activity.ts b/web/ce/types/projects/project-activity.ts
index ed75a6b9c8..d060b4cc88 100644
--- a/web/ce/types/projects/project-activity.ts
+++ b/web/ce/types/projects/project-activity.ts
@@ -1,25 +1,3 @@
-export interface TProjectActivity {
- id: string;
- content: string;
- createdAt: string;
- updatedAt: string;
- userId: string;
- projectId: string;
- created_at: string;
- field: string;
- verb: string;
- actor_detail: {
- display_name: string;
- id: string;
- };
- workspace_detail: {
- slug: string;
- };
- project_detail: {
- name: string;
- };
- new_value: string;
- old_value: string;
- project: string;
- new_identifier?: string;
-}
+import { TProjectBaseActivity } from "@plane/types";
+
+export type TProjectActivity = TProjectBaseActivity;
diff --git a/web/core/components/common/activity/activity-block.tsx b/web/core/components/common/activity/activity-block.tsx
index 84f2dc9a47..0f1c2429f4 100644
--- a/web/core/components/common/activity/activity-block.tsx
+++ b/web/core/components/common/activity/activity-block.tsx
@@ -2,16 +2,20 @@
import { FC, ReactNode } from "react";
import { Network } from "lucide-react";
-// hooks
+// types
+import { TWorkspaceBaseActivity } from "@plane/types";
+// ui
import { Tooltip } from "@plane/ui";
+// helpers
import { renderFormattedTime, renderFormattedDate, calculateTimeAgo } from "@/helpers/date-time.helper";
+// hooks
import { usePlatformOS } from "@/hooks/use-platform-os";
-import { TProjectActivity } from "@/plane-web/types";
+// local components
import { User } from "./user";
type TActivityBlockComponent = {
icon?: ReactNode;
- activity: TProjectActivity;
+ activity: TWorkspaceBaseActivity;
ends: "top" | "bottom" | undefined;
children: ReactNode;
customUserName?: string;
@@ -25,12 +29,11 @@ export const ActivityBlockComponent: FC<TActivityBlockComponent> = (props) => {
if (!activity) return <></>;
return (
<div
- className={`relative flex items-center gap-3 text-xs ${
- ends === "top" ? `pb-2` : ends === "bottom" ? `pt-2` : `py-2`
+ className={`relative flex items-center gap-2 text-xs ${
+ ends === "top" ? `pb-3` : ends === "bottom" ? `pt-3` : `py-3`
}`}
>
- <div className="absolute left-[13px] top-0 bottom-0 w-0.5 bg-custom-background-80" aria-hidden />
- <div className="flex-shrink-0 ring-6 w-7 h-7 rounded-full overflow-hidden flex justify-center items-center z-[4] bg-custom-background-80 text-custom-text-200">
+ <div className="flex-shrink-0 ring-6 w-7 h-7 rounded-full overflow-hidden flex justify-center items-start mt-0.5 z-[4] text-custom-text-200">
{icon ? icon : <Network className="w-3.5 h-3.5" />}
</div>
<div className="w-full truncate text-custom-text-200">
@@ -40,7 +43,7 @@ export const ActivityBlockComponent: FC<TActivityBlockComponent> = (props) => {
isMobile={isMobile}
tooltipContent={`${renderFormattedDate(activity.created_at)}, ${renderFormattedTime(activity.created_at)}`}
>
- <span className="whitespace-nowrap text-custom-text-350 font-medium">
+ <span className="whitespace-nowrap text-custom-text-350 font-medium cursor-help">
{calculateTimeAgo(activity.created_at)}
</span>
</Tooltip>
diff --git a/web/core/components/common/activity/activity-item.tsx b/web/core/components/common/activity/activity-item.tsx
index 2bf6ef5442..643d897383 100644
--- a/web/core/components/common/activity/activity-item.tsx
+++ b/web/core/components/common/activity/activity-item.tsx
@@ -19,6 +19,8 @@ export const ActivityItem: FC<TActivityItem> = observer((props) => {
if (!activity) return null;
const activityType = activity.field;
+ if (!activityType) return null;
+
const { message, customUserName } = messages(activity);
const icon = iconsMap[activityType] || iconsMap.default;
diff --git a/web/core/components/common/activity/helper.tsx b/web/core/components/common/activity/helper.tsx
index dda68477dd..54ccd56e2b 100644
--- a/web/core/components/common/activity/helper.tsx
+++ b/web/core/components/common/activity/helper.tsx
@@ -26,6 +26,7 @@ import {
// components
import { ArchiveIcon, DoubleCircleIcon, ContrastIcon, DiceIcon, Intake } from "@plane/ui";
+import { store } from "@/lib/store-context";
import { TProjectActivity } from "@/plane-web/types";
type ActivityIconMap = {
@@ -70,8 +71,9 @@ export const messages = (activity: TProjectActivity): { message: string | ReactN
const newValue = activity.new_value;
const oldValue = activity.old_value;
const verb = activity.verb;
+ const workspaceDetail = store.workspaceRoot.getWorkspaceById(activity.workspace);
- const getBooleanActionText = (value: string) => {
+ const getBooleanActionText = (value: string | undefined) => {
if (value === "true") return "enabled";
if (value === "false") return "disabled";
return verb;
@@ -170,7 +172,7 @@ export const messages = (activity: TProjectActivity): { message: string | ReactN
</span>
{verb !== "removed" ? (
<a
- href={`/${activity.workspace_detail?.slug}/projects/${activity.project}/cycles/${activity.new_identifier}`}
+ href={`/${workspaceDetail?.slug}/projects/${activity.project}/cycles/${activity.new_identifier}`}
target="_blank"
rel="noopener noreferrer"
className="inline-flex font-medium text-custom-text-100"
@@ -273,7 +275,7 @@ export const messages = (activity: TProjectActivity): { message: string | ReactN
};
default:
return {
- message: `${verb} ${activityType.replace(/_/g, " ")} `,
+ message: `${verb} ${activityType?.replace(/_/g, " ")} `,
};
}
};
diff --git a/web/core/components/common/activity/user.tsx b/web/core/components/common/activity/user.tsx
index 0229d80e85..c82ab36162 100644
--- a/web/core/components/common/activity/user.tsx
+++ b/web/core/components/common/activity/user.tsx
@@ -1,27 +1,37 @@
import { FC } from "react";
+import { observer } from "mobx-react";
import Link from "next/link";
-import { TProjectActivity } from "@/plane-web/types";
+// types
+import { TWorkspaceBaseActivity } from "@plane/types";
+// store hooks
+import { useMember, useWorkspace } from "@/hooks/store";
type TUser = {
- activity: TProjectActivity;
+ activity: TWorkspaceBaseActivity;
customUserName?: string;
};
-export const User: FC<TUser> = (props) => {
+export const User: FC<TUser> = observer((props) => {
const { activity, customUserName } = props;
+ // store hooks
+ const { getUserDetails } = useMember();
+ const { getWorkspaceById } = useWorkspace();
+ // derived values
+ const actorDetail = getUserDetails(activity.actor);
+ const workspaceDetail = getWorkspaceById(activity.workspace);
return (
<>
- {customUserName || activity.actor_detail?.display_name.includes("-intake") ? (
+ {customUserName || actorDetail?.display_name.includes("-intake") ? (
<span className="text-custom-text-100 font-medium">{customUserName || "Plane"}</span>
) : (
<Link
- href={`/${activity?.workspace_detail?.slug}/profile/${activity?.actor_detail?.id}`}
+ href={`/${workspaceDetail?.slug}/profile/${actorDetail?.id}`}
className="hover:underline text-custom-text-100 font-medium"
>
- {activity.actor_detail?.display_name}
+ {actorDetail?.display_name}
</Link>
)}
</>
);
-};
+});