Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Feat] Resource Link API #8399

Merged
merged 7 commits into from
Oct 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 2 additions & 25 deletions packages/contracts/src/activity-log.model.ts
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
import { ActorTypeEnum, IBasePerTenantAndOrganizationEntityModel, ID, JsonData } from './base-entity.model';
import { ActorTypeEnum, EntityEnum, IBasePerTenantAndOrganizationEntityModel, ID, JsonData } from './base-entity.model';
import { IUser } from './user.model';

/**
* Interface representing an activity log entry.
*/
export interface IActivityLog extends IBasePerTenantAndOrganizationEntityModel {
entity: ActivityLogEntityEnum; // Entity / Table name concerned by activity log
entity: EntityEnum; // Entity / Table name concerned by activity log
entityId: ID; // The ID of the element we are interacting with (a task, an organization, an employee, ...)
action: ActionTypeEnum;
actorType?: ActorTypeEnum;
Expand Down Expand Up @@ -33,29 +33,6 @@ export enum ActionTypeEnum {
Deleted = 'Deleted'
}

/**
* Enum for entities that can be involved in activity logs.
*/
export enum ActivityLogEntityEnum {
Candidate = 'Candidate',
Contact = 'Contact',
Employee = 'Employee',
Expense = 'Expense',
DailyPlan = 'DailyPlan',
Invoice = 'Invoice',
Income = 'Income',
Organization = 'Organization',
OrganizationContact = 'OrganizationContact',
OrganizationDepartment = 'OrganizationDepartment',
OrganizationDocument = 'OrganizationDocument',
OrganizationProject = 'OrganizationProject',
OrganizationTeam = 'OrganizationTeam',
OrganizationProjectModule = 'OrganizationProjectModule',
OrganizationSprint = 'OrganizationSprint',
Task = 'Task',
User = 'User'
}

/**
* Input type for activity log creation, excluding `creatorId` and `creator`.
*/
Expand Down
20 changes: 20 additions & 0 deletions packages/contracts/src/base-entity.model.ts
Original file line number Diff line number Diff line change
Expand Up @@ -64,3 +64,23 @@ export enum ActorTypeEnum {
System = 0, // System performed the action
User = 1 // User performed the action
}

export enum EntityEnum {
Candidate = 'Candidate',
Contact = 'Contact',
Employee = 'Employee',
Expense = 'Expense',
DailyPlan = 'DailyPlan',
Invoice = 'Invoice',
Income = 'Income',
Organization = 'Organization',
OrganizationContact = 'OrganizationContact',
OrganizationDepartment = 'OrganizationDepartment',
OrganizationDocument = 'OrganizationDocument',
OrganizationProject = 'OrganizationProject',
OrganizationTeam = 'OrganizationTeam',
OrganizationProjectModule = 'OrganizationProjectModule',
OrganizationSprint = 'OrganizationSprint',
Task = 'Task',
User = 'User'
}
4 changes: 3 additions & 1 deletion packages/contracts/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,7 @@ export * from './report.model';
export * from './request-approval-employee.model';
export * from './request-approval-team.model';
export * from './request-approval.model';
export * from './resource-link.model';
export * from './role-permission.model';
export * from './role.model';
export * from './screenshot.model';
Expand Down Expand Up @@ -144,7 +145,8 @@ export {
IBaseSoftDeleteEntityModel,
IBaseRelationsEntityModel,
ActorTypeEnum,
JsonData
JsonData,
EntityEnum
} from './base-entity.model';

export * from './proxy.model';
19 changes: 19 additions & 0 deletions packages/contracts/src/resource-link.model.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
import { IURLMetaData } from './timesheet.model';
import { EntityEnum, IBasePerTenantAndOrganizationEntityModel, ID } from './base-entity.model';
import { IUser } from './user.model';

export interface IResourceLink extends IBasePerTenantAndOrganizationEntityModel {
entity: EntityEnum;
entityId: ID;
title: string;
url: string;
creator?: IUser;
creatorId?: ID;
metaData?: string | IURLMetaData;
}

export interface IResourceLinkCreateInput extends Omit<IResourceLink, 'creator' | 'creatorId'> {}

export interface IResourceLinkUpdateInput extends Partial<Omit<IResourceLinkCreateInput, 'entity' | 'entityId'>> {}

export interface IResourceLinkFindInput extends Pick<IResourceLink, 'entity' | 'entityId'> {}
16 changes: 4 additions & 12 deletions packages/core/src/activity-log/activity-log.entity.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,7 @@ import { EntityRepositoryType } from '@mikro-orm/core';
import { JoinColumn, RelationId } from 'typeorm';
import { IsArray, IsEnum, IsNotEmpty, IsOptional, IsString, IsUUID } from 'class-validator';
import { isMySQL, isPostgres } from '@gauzy/config';
import {
ActivityLogEntityEnum,
ActionTypeEnum,
ActorTypeEnum,
IActivityLog,
ID,
IUser,
JsonData
} from '@gauzy/contracts';
import { EntityEnum, ActionTypeEnum, ActorTypeEnum, IActivityLog, ID, IUser, JsonData } from '@gauzy/contracts';
import { TenantOrganizationBaseEntity, User } from '../core/entities/internal';
import { ColumnIndex, MultiORMColumn, MultiORMEntity, MultiORMManyToOne } from '../core/decorators/entity';
import { MikroOrmActivityLogRepository } from './repository/mikro-orm-activity-log.repository';
Expand All @@ -20,12 +12,12 @@ import { MikroOrmActivityLogRepository } from './repository/mikro-orm-activity-l
export class ActivityLog extends TenantOrganizationBaseEntity implements IActivityLog {
[EntityRepositoryType]?: MikroOrmActivityLogRepository;

@ApiProperty({ type: () => String, enum: ActivityLogEntityEnum })
@ApiProperty({ enum: EntityEnum })
@IsNotEmpty()
@IsEnum(ActivityLogEntityEnum)
@IsEnum(EntityEnum)
@ColumnIndex()
@MultiORMColumn()
entity: ActivityLogEntityEnum;
entity: EntityEnum;

@ApiProperty({ type: () => String })
@IsNotEmpty()
Expand Down
8 changes: 2 additions & 6 deletions packages/core/src/activity-log/activity-log.helper.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { ActionTypeEnum, ActivityLogEntityEnum, IActivityLogUpdatedValues } from '@gauzy/contracts';
import { ActionTypeEnum, EntityEnum, IActivityLogUpdatedValues } from '@gauzy/contracts';

const ActivityTemplates = {
[ActionTypeEnum.Created]: `{action} a new {entity} called "{entityName}"`,
Expand All @@ -13,11 +13,7 @@ const ActivityTemplates = {
* @param entityName - The name of the specific entity instance.
* @returns A formatted description string.
*/
export function generateActivityLogDescription(
action: ActionTypeEnum,
entity: ActivityLogEntityEnum,
entityName: string
): string {
export function generateActivityLogDescription(action: ActionTypeEnum, entity: EntityEnum, entityName: string): string {
// Get the template corresponding to the action
const template = ActivityTemplates[action] || '{action} {entity} "{entityName}"';

Expand Down
10 changes: 5 additions & 5 deletions packages/core/src/activity-log/dto/get-activity-logs.dto.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { ApiPropertyOptional, IntersectionType, PickType } from '@nestjs/swagger';
import { IsEnum, IsIn, IsOptional, IsString, IsUUID } from 'class-validator';
import { ActionTypeEnum, ActivityLogEntityEnum, ActorTypeEnum, ID } from '@gauzy/contracts';
import { ActionTypeEnum, EntityEnum, ActorTypeEnum, ID } from '@gauzy/contracts';
import { PaginationParams } from '../../core/crud';
import { TenantOrganizationBaseDTO } from '../../core/dto';
import { ActivityLog } from '../activity-log.entity';
Expand All @@ -18,10 +18,10 @@ export class GetActivityLogsDTO extends IntersectionType(
PickType(ActivityLog, ['isActive', 'isArchived'])
) {
// Filter by entity (example: Organization, Task, OrganizationContact)
@ApiPropertyOptional({ type: () => String, enum: ActivityLogEntityEnum })
@ApiPropertyOptional({ enum: EntityEnum })
@IsOptional()
@IsEnum(ActivityLogEntityEnum)
entity: ActivityLogEntityEnum;
@IsEnum(EntityEnum)
entity: EntityEnum;

// Filter by entityId (example: projectId, taskId, organizationContactId)
@ApiPropertyOptional({ type: () => String })
Expand All @@ -30,7 +30,7 @@ export class GetActivityLogsDTO extends IntersectionType(
entityId: ID;

// Filter by action (example: CREATED, UPDATED, DELETED)
@ApiPropertyOptional({ type: () => String, enum: ActionTypeEnum })
@ApiPropertyOptional({ enum: ActionTypeEnum })
@IsOptional()
@IsEnum(ActionTypeEnum)
action: ActionTypeEnum;
Expand Down
4 changes: 3 additions & 1 deletion packages/core/src/app.module.ts
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,7 @@ import { ReactionModule } from './reaction/reaction.module';
import { ActivityLogModule } from './activity-log/activity-log.module';
import { ApiCallLogModule } from './api-call-log/api-call-log.module'; // Global Api Call Log Module
import { TaskViewModule } from './tasks/views/view.module';
import { ResourceLinkModule } from './resource-link/resource-link.module';

const { unleashConfig } = environment;

Expand Down Expand Up @@ -449,7 +450,8 @@ if (environment.THROTTLE_ENABLED) {
CommentModule,
ActivityLogModule,
ApiCallLogModule,
TaskViewModule // Task views Module
TaskViewModule,
ResourceLinkModule // Task views Module
],
controllers: [AppController],
providers: [
Expand Down
2 changes: 2 additions & 0 deletions packages/core/src/core/entities/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,7 @@ import {
RequestApproval,
RequestApprovalEmployee,
RequestApprovalTeam,
ResourceLink,
Role,
RolePermission,
Screenshot,
Expand Down Expand Up @@ -266,6 +267,7 @@ export const coreEntities = [
RequestApproval,
RequestApprovalEmployee,
RequestApprovalTeam,
ResourceLink,
Role,
RolePermission,
Screenshot,
Expand Down
2 changes: 2 additions & 0 deletions packages/core/src/core/entities/internal.ts
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,7 @@ export * from '../../reports/report.entity';
export * from '../../request-approval-employee/request-approval-employee.entity';
export * from '../../request-approval-team/request-approval-team.entity';
export * from '../../request-approval/request-approval.entity';
export * from '../../resource-link/resource-link.entity';
export * from '../../role-permission/role-permission.entity';
export * from '../../role/role.entity';
export * from '../../skills/skill.entity';
Expand Down Expand Up @@ -178,6 +179,7 @@ export * from '../../payment/payment.subscriber';
export * from '../../pipeline/pipeline.subscriber';
export * from '../../product-category/product-category.subscriber';
export * from '../../reports/report.subscriber';
export * from '../../resource-link/resource-link.subscriber';
export * from '../../role/role.subscriber';
export * from '../../tags/tag.subscriber';
export * from '../../tasks/issue-type/issue-type.subscriber';
Expand Down
2 changes: 2 additions & 0 deletions packages/core/src/core/entities/subscribers/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ import {
PipelineSubscriber,
ProductCategorySubscriber,
ReportSubscriber,
ResourceLinkSubscriber,
RoleSubscriber,
ScreenshotSubscriber,
TagSubscriber,
Expand Down Expand Up @@ -82,6 +83,7 @@ export const coreSubscribers = [
PipelineSubscriber,
ProductCategorySubscriber,
ReportSubscriber,
ResourceLinkSubscriber,
RoleSubscriber,
ScreenshotSubscriber,
TagSubscriber,
Expand Down
Loading