Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 | 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 6x 6x 6x 6x 6x 6x 6x 6x 6x 6x 6x 6x 6x 6x 6x 6x 6x 6x 6x 6x 6x 6x 6x 1x 1x 1x 1x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 1x 1x 1x 1x 1x 1x 1x 1x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 1x 1x 1x 1x 1x 1x 1x 1x 5x 5x 5x 5x 5x 4x 4x 1x 1x 1x 1x 3x 3x 3x 3x 3x 3x 2x 1x 1x 1x 1x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 1x 1x 1x 1x 1x 1x 1x 1x 3x 3x 3x 3x 3x 3x 3x 3x 3x 1x 1x 1x 1x 1x 1x 1x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x | import {
Body,
Controller,
Delete,
ForbiddenException,
Get,
Logger,
Param,
Patch,
Post,
Put,
Query,
UseGuards,
} from '@nestjs/common';
import { ApiBearerAuth, ApiTags } from '@nestjs/swagger';
import { SetRequired } from 'type-fest';
import { Company, type Plan } from '@amalia/core/models';
import { EngineError } from '@amalia/core/types';
import { assert } from '@amalia/ext/typescript';
import { BooleanPipe, EnumPipe, StringPipe, UuidPipe } from '@amalia/kernel/api';
import {
AmaliaAuthGuard,
CheckPolicies,
CurrentAuthenticatedContext,
CurrentUserCompany,
PoliciesGuard,
} from '@amalia/kernel/auth/core';
import {
canAssignValuesToQuotas,
canModifyPlans,
canViewPlans,
canViewPlanTokens,
canViewThisPlan,
defineAbilityFor,
} from '@amalia/kernel/auth/shared';
import { type AuthenticatedContext } from '@amalia/kernel/auth/types';
import {
DuplicatePlanDTO,
ImportTokenFromOtherPlanDTO,
PatchPlanDto,
PatchPlanForecastingConfigurationDto,
PatchPlanVisibilityDTO,
PatchPlanWorkflowDto,
PutPlanRulesOrderDto,
} from '@amalia/payout-definition/plans/api';
import {
CreatePlanBadgeConfigurationUseCase,
CreatePlanCategoryUseCase,
DeletePlanBadgeConfigurationUseCase,
DeletePlanCategoryUseCase,
DuplicatePlanUseCase,
ImportTokenFromOtherPlanUseCase,
IsPlanDeletableUseCase,
IsPlanUnpublishableUseCase,
PatchPlanBadgeConfigurationUseCase,
PatchPlanCategoryUseCase,
PatchPlanForecastingConfigurationUseCase,
PatchPlanUseCase,
PatchPlanVisibilityUseCase,
PatchPlanWorkflowUseCase,
PutPlanRulesOrderUseCase,
} from '@amalia/payout-definition/plans/core';
import {
BadgeConfiguration,
PlanCategory,
PlanVisibility,
type PlanResponseDto,
} from '@amalia/payout-definition/plans/types';
import { ArchivePlanDto } from './dto/archivePlan.dto';
import { CreatePlanDto } from './dto/createPlan.dto';
import { CreatePlanBadgeConfigurationDTO, PatchPlanBadgeConfigurationDTO } from './dto/plan-badge-configuration.dto';
import { CreatePlanCategoryDTO, PatchPlanCategoryDTO } from './dto/plan-category.dto';
import { formatPlanResponse } from './dto/planResponse.dto';
import { PlansService } from './plans.service';
@UseGuards(AmaliaAuthGuard, PoliciesGuard)
@ApiBearerAuth()
@ApiTags('plans')
@Controller('plans')
export class PlansController {
private readonly logger = new Logger(PlansController.name);
public constructor(
private readonly planService: PlansService,
private readonly patchPlanVisibilityUseCase: PatchPlanVisibilityUseCase,
private readonly patchPlanWorkflowUseCase: PatchPlanWorkflowUseCase,
private readonly patchPlanUseCase: PatchPlanUseCase,
private readonly patchPlanForecastingConfigurationUseCase: PatchPlanForecastingConfigurationUseCase,
private readonly putPlanRulesOrderUseCase: PutPlanRulesOrderUseCase,
private readonly duplicatePlanUseCase: DuplicatePlanUseCase,
private readonly importTokenFromOtherPlanUseCase: ImportTokenFromOtherPlanUseCase,
private readonly createPlanBadgeConfigurationUseCase: CreatePlanBadgeConfigurationUseCase,
private readonly patchPlanBadgeConfigurationUseCase: PatchPlanBadgeConfigurationUseCase,
private readonly deletePlanBadgeConfigurationUseCase: DeletePlanBadgeConfigurationUseCase,
private readonly createPlanCategoryUseCase: CreatePlanCategoryUseCase,
private readonly patchPlanCategoryUseCase: PatchPlanCategoryUseCase,
private readonly deletePlanCategoryUseCase: DeletePlanCategoryUseCase,
private readonly isPlanDeletableUseCase: IsPlanDeletableUseCase,
private readonly isPlanUnpublishableUseCase: IsPlanUnpublishableUseCase,
) {}
/**
* Find all plans for a user and company.
* @param authenticatedContext
* @param company
* @param userIds
* @param planIds
* @param periodId
*/
@Get()
public async findAll(
@CurrentAuthenticatedContext() authenticatedContext: AuthenticatedContext,
@CurrentUserCompany() company: Company,
@Query('userIds', new UuidPipe({ optional: true, multiple: true })) userIds: string[] | null = null,
@Query('planIds', new UuidPipe({ optional: true, multiple: true })) planIds: string[] | null = null,
@Query('periodId', new UuidPipe({ optional: true })) periodId: string | null = null,
@Query('search', new StringPipe({ optional: true })) search: string | null = null,
@Query('showArchived', new BooleanPipe({ optional: true })) showArchived: boolean = false,
@Query('planStatus', new EnumPipe({ enum: PlanVisibility, optional: true }))
planStatus: PlanVisibility | null = null,
): Promise<SetRequired<Plan, 'planAssignements'>[]> {
const plans = await this.planService.findAllWhereUserAuthorized({
company,
authenticatedContext,
userIds,
periodId,
search,
showArchived,
planStatus,
});
// Eventually filter the list if needed.
return planIds ? plans.filter((p) => planIds.includes(p.id)) : plans;
}
@Get('search/:keyword')
@CheckPolicies((ability) => canViewPlanTokens(ability) || canAssignValuesToQuotas(ability))
public async searchKeywordInPlan(
@Param('keyword', new StringPipe()) keyword: string,
@CurrentUserCompany() company: Company,
@CurrentAuthenticatedContext() authenticatedContext: AuthenticatedContext,
): Promise<PlanResponseDto[]> {
// To be able to view plan assignments, user must be able to view quota assignments as well (used in quota page to filter users)
if (!canAssignValuesToQuotas(defineAbilityFor(authenticatedContext))) {
throw new ForbiddenException("You don't have access to plan assignments as you can't access quota assignments");
}
const plans = await this.planService.searchForKeyword(company, keyword, ['plan_assignements']);
return plans.map(formatPlanResponse);
}
@Get('modifiers')
@CheckPolicies((ability) => canModifyPlans(ability))
public async isDeletable(
@Query('planIds', new UuidPipe({ multiple: true })) planIds: Plan['id'][],
@CurrentAuthenticatedContext() authenticatedContext: AuthenticatedContext,
): Promise<Record<Plan['id'], { isDeletable: boolean; isUnpublishable: boolean }>> {
const [isDeletableMap, isUnpublishableMap] = await Promise.all([
this.isPlanDeletableUseCase.execute({ authenticatedContext, planIds }),
this.isPlanUnpublishableUseCase.execute({ authenticatedContext, planIds }),
]);
return planIds.reduce(
(acc, planId) => {
acc[planId] = {
isDeletable: !!isDeletableMap[planId],
isUnpublishable: !!isUnpublishableMap[planId],
};
return acc;
},
{} as Record<Plan['id'], { isDeletable: boolean; isUnpublishable: boolean }>,
);
}
@Get(':id')
@CheckPolicies((ability) => canViewPlans(ability))
public async findOne(
@Param('id', new UuidPipe()) id: string,
@CurrentUserCompany() company: Company,
@CurrentAuthenticatedContext() authenticatedContext: AuthenticatedContext,
): Promise<PlanResponseDto> {
const relations = [
'planRules',
'planRules.rule',
'planAssignements',
'highlightedKpis',
'highlightedKpis.variable',
'badgeConfigurations',
];
const plan = await this.planService.findById(company, id, relations);
const ability = defineAbilityFor(authenticatedContext);
assert(canViewThisPlan(ability, plan), new ForbiddenException('Cannot access this plan.'));
return formatPlanResponse(plan);
}
@Get(':id/template')
@CheckPolicies((ability) => canViewPlans(ability))
public async getOnePlanTemplate(
@Param('id', new UuidPipe()) id: string,
@CurrentUserCompany() company: Company,
@CurrentAuthenticatedContext() authenticatedContext: AuthenticatedContext,
): Promise<{ template?: Plan['planTemplate']; error?: EngineError }> {
const plan = await this.planService.findById(company, id, [], true);
const ability = defineAbilityFor(authenticatedContext);
assert(canViewThisPlan(ability, plan), new ForbiddenException('Cannot access this plan.'));
return plan.planTemplateError ? { error: plan.planTemplateError } : { template: plan.planTemplate };
}
@Post()
@CheckPolicies((ability) => canModifyPlans(ability))
public async create(
@Body() plan: CreatePlanDto,
@CurrentAuthenticatedContext() authenticatedContext: AuthenticatedContext,
@CurrentUserCompany() company: Company,
): Promise<PlanResponseDto> {
const createdPlan = await this.planService.create(company, authenticatedContext, plan);
return formatPlanResponse(createdPlan);
}
@Delete(':planId')
@CheckPolicies((ability) => canModifyPlans(ability))
public async delete(
@Param('planId', new UuidPipe()) planId: string,
@CurrentUserCompany() company: Company,
@CurrentAuthenticatedContext() authenticatedContext: AuthenticatedContext,
): Promise<void> {
this.logger.log(`Delete plan ${planId}`);
await this.planService.delete(company, planId, authenticatedContext);
}
@Patch(':planId/visibility')
@CheckPolicies((ability) => canModifyPlans(ability))
public async patchPlanVisibility(
@Param('planId', new UuidPipe()) planId: string,
@Body() patch: PatchPlanVisibilityDTO,
@CurrentAuthenticatedContext() authenticatedContext: AuthenticatedContext,
@CurrentUserCompany() company: Company,
): Promise<PlanResponseDto> {
await this.patchPlanVisibilityUseCase.execute({
authenticatedContext,
companyId: company.id,
planId,
patch,
});
return formatPlanResponse(await this.planService.findById(company, planId));
}
@Patch(':planId/workflow')
@CheckPolicies((ability) => canModifyPlans(ability))
public async patchPlanWorkflow(
@Param('planId', new UuidPipe()) planId: Plan['id'],
@CurrentAuthenticatedContext() authenticatedContext: AuthenticatedContext,
@Body() patchPlanWorkflowRequest: PatchPlanWorkflowDto,
): Promise<PlanResponseDto> {
await this.patchPlanWorkflowUseCase.execute({
authenticatedContext,
planId,
patchPlanWorkflowRequest,
});
return formatPlanResponse(await this.planService.findById(authenticatedContext.user.company, planId));
}
@Patch(':planId')
@CheckPolicies((ability) => canModifyPlans(ability))
public async patchPlan(
@Param('planId', new UuidPipe()) planId: Plan['id'],
@CurrentAuthenticatedContext() authenticatedContext: AuthenticatedContext,
@Body() patchPlanRequest: PatchPlanDto,
): Promise<PlanResponseDto> {
await this.patchPlanUseCase.execute({
authenticatedContext,
planId,
request: patchPlanRequest,
});
return formatPlanResponse(await this.planService.findById(authenticatedContext.user.company, planId));
}
@Patch(':planId/forecasting-configuration')
@CheckPolicies((ability) => canModifyPlans(ability))
public async patchPlanForecastingConfiguration(
@Param('planId', new UuidPipe()) planId: Plan['id'],
@CurrentAuthenticatedContext() authenticatedContext: AuthenticatedContext,
@Body() patchPlanForecastingConfigurationRequest: PatchPlanForecastingConfigurationDto,
): Promise<PlanResponseDto> {
await this.patchPlanForecastingConfigurationUseCase.execute({
authenticatedContext,
planId,
patchPlanForecastingConfigurationRequest,
});
return formatPlanResponse(await this.planService.findById(authenticatedContext.user.company, planId));
}
@Put(':planId/rules-order')
@CheckPolicies((ability) => canModifyPlans(ability))
public async putPlanRulesOrder(
@Param('planId', new UuidPipe()) planId: Plan['id'],
@CurrentAuthenticatedContext() authenticatedContext: AuthenticatedContext,
@Body() putPlanRulesOrderRequest: PutPlanRulesOrderDto,
): Promise<void> {
await this.putPlanRulesOrderUseCase.execute({
authenticatedContext,
planId,
request: putPlanRulesOrderRequest,
});
}
@Put('archive/:planId')
@CheckPolicies((ability) => canModifyPlans(ability))
public async archive(
@Param('planId', new UuidPipe()) planId: string,
@Body() body: ArchivePlanDto,
@CurrentAuthenticatedContext() authenticatedContext: AuthenticatedContext,
@CurrentUserCompany() company: Company,
): Promise<PlanResponseDto> {
if (body.archived) {
const updatedPlan = await this.planService.archivePlan(company, planId, authenticatedContext);
return formatPlanResponse(updatedPlan);
}
const updatedPlan = await this.planService.unarchivePlan(company, planId, authenticatedContext);
return formatPlanResponse(updatedPlan);
}
@Post(':planId/duplicate')
@CheckPolicies((ability) => canModifyPlans(ability))
public async duplicate(
@Param('planId', new UuidPipe()) planId: string,
@CurrentUserCompany() company: Company,
@Body() postDuplicateRequest: DuplicatePlanDTO,
@CurrentAuthenticatedContext() authenticatedContext: AuthenticatedContext,
): Promise<PlanResponseDto> {
const duplicatedPlan = await this.duplicatePlanUseCase.execute({
planId,
companyId: company.id,
postDuplicateRequest,
authenticatedContext,
});
return formatPlanResponse(duplicatedPlan);
}
@Post(':planId/import-token-from-other-plan')
@CheckPolicies((ability) => canModifyPlans(ability))
public async importTokenFromOtherPlan(
@CurrentAuthenticatedContext() authenticatedContext: AuthenticatedContext,
@Param('planId', new UuidPipe()) planId: string,
@Body() postBody: ImportTokenFromOtherPlanDTO,
): Promise<void> {
return this.importTokenFromOtherPlanUseCase.execute({
authenticatedContext,
planIdToImportTo: planId,
request: postBody,
});
}
@Post(':planId/badges')
@CheckPolicies((ability) => canModifyPlans(ability))
public async createBadgeConfiguration(
@CurrentAuthenticatedContext() authenticatedContext: AuthenticatedContext,
@Param('planId', new UuidPipe()) planId: Plan['id'],
@Body() createBadgeDto: CreatePlanBadgeConfigurationDTO,
): Promise<void> {
await this.createPlanBadgeConfigurationUseCase.execute({
authenticatedContext,
planId,
createPlanBadgeConfigurationRequest: createBadgeDto,
});
}
@Patch(':planId/badges/:badgeId')
@CheckPolicies((ability) => canModifyPlans(ability))
public async patchBadgeConfiguration(
@CurrentAuthenticatedContext() authenticatedContext: AuthenticatedContext,
@Param('planId', new UuidPipe()) planId: Plan['id'],
@Param('badgeId', new UuidPipe()) badgeId: BadgeConfiguration['id'],
@Body() patchBadgeDto: PatchPlanBadgeConfigurationDTO,
): Promise<void> {
await this.patchPlanBadgeConfigurationUseCase.execute({
authenticatedContext,
planId,
badgeId,
patchPlanBadgeConfigurationRequest: patchBadgeDto,
});
}
@Delete(':planId/badges/:badgeId')
@CheckPolicies((ability) => canModifyPlans(ability))
public async deleteBadgeConfiguration(
@CurrentAuthenticatedContext() authenticatedContext: AuthenticatedContext,
@Param('planId', new UuidPipe()) planId: Plan['id'],
@Param('badgeId', new UuidPipe()) badgeId: BadgeConfiguration['id'],
): Promise<void> {
await this.deletePlanBadgeConfigurationUseCase.execute({
authenticatedContext,
planId,
badgeId,
});
}
@Post(':planId/categories')
@CheckPolicies((ability) => canModifyPlans(ability))
public async createCategory(
@CurrentAuthenticatedContext() authenticatedContext: AuthenticatedContext,
@Param('planId', new UuidPipe()) planId: Plan['id'],
@Body() createPlanCategoryDTO: CreatePlanCategoryDTO,
): Promise<void> {
await this.createPlanCategoryUseCase.execute({
authenticatedContext,
planId,
createPlanCategoryRequest: createPlanCategoryDTO,
});
}
@Put(':planId/categories/:categoryName')
@CheckPolicies((ability) => canModifyPlans(ability))
public async updateCategory(
@CurrentAuthenticatedContext() authenticatedContext: AuthenticatedContext,
@Param('planId', new UuidPipe()) planId: Plan['id'],
@Param('categoryName', new StringPipe()) categoryName: PlanCategory['name'],
@Body() patchPlanCategoryDTO: PatchPlanCategoryDTO,
): Promise<void> {
await this.patchPlanCategoryUseCase.execute({
authenticatedContext,
planId,
categoryName,
patchPlanCategoryRequest: patchPlanCategoryDTO,
});
}
@Delete(':planId/categories/:categoryName')
@CheckPolicies((ability) => canModifyPlans(ability))
public async deleteCategory(
@CurrentAuthenticatedContext() authenticatedContext: AuthenticatedContext,
@Param('planId', new UuidPipe()) planId: Plan['id'],
@Param('categoryName', new StringPipe()) categoryName: PlanCategory['name'],
): Promise<void> {
await this.deletePlanCategoryUseCase.execute({
authenticatedContext,
planId,
categoryName,
});
}
}
|