feat: public projects, project deletion and sagas
Public projects:
- Project.isPublic (create/update, owners and admins). Anyone can read a
public project without a token: project, board, tickets, comments,
history, releases, activity, tracking and statistics, over GraphQL and
REST. Writes stay for members (401 anonymous, 403 outsiders).
- @OptionalAuth() / @ApiOptionalPireonAuth(): anonymous callers allowed,
invalid tokens still rejected. ReadAccess lets anonymous viewers read
public projects only; linked tickets are filtered by visibility.
- publicProjects (GraphQL) and GET /api/explore/projects (REST).
- Web: «Explorar» page, project pages open without a session (read-only
notice, sign-in hints), public badge, visibility switch in settings,
no realtime subscriptions without a session.
Project deletion:
- Owner only, confirming the key (deleteProject / DELETE
/api/projects/{project}?confirm=KEY). The key is freed; the read model
drops the project and members are notified (web goes home).
Sagas (run by the EventsBridge after projections, durable and ordered):
- ProjectDeletionSaga: project deleted → delete its tickets and releases;
ticket deleted → purge its comments and drop links from other tickets.
- ReleaseArchivedSaga: unfinished tickets leave an archived release.
- UserDeactivatedSaga: the Pireon webhook records UserDeactivatedEvent in
the event store (EventRecorder); the tracker unassigns that user's open
tickets as the system actor.
- Internal idempotent commands; domain refusals are logged and skipped,
concurrency conflicts retried. Affected streams come from the event store
(TrackerStreamsRepository).
Tests: domain lifecycle specs, saga specs run like the bridge, facade
tests, e2e for public access, cascade deletion, archived releases and
deactivation webhook. Docs, READMEs, schema.gql/openapi.json and Word/PDF
updated.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
@@ -12,6 +12,8 @@ API GraphQL y REST (OpenAPI) del tracker.
|
||||
- `http/`: controladores REST `ProjectsController`, `IssuesController`, `CommentsController`, `ReleasesController`
|
||||
(mismos services), DTOs con `@nestjs/swagger` y `Refs` (proyectos y tickets por id o clave; añade a cada ticket sus
|
||||
transiciones permitidas según el workflow de su proyecto).
|
||||
- `ExploreController` (`GET /api/explore/projects`, sin token). Las lecturas usan `@OptionalAuth()` y `viewerOf(me)`
|
||||
(null = anónimo) para servir proyectos públicos sin sesión.
|
||||
- `common/settings.ts`: configuración del proyecto con las transiciones como lista (lo que viaja por GraphQL y REST).
|
||||
|
||||
Operaciones disponibles: [GraphQL](../../../../docs/03-api.md#32-graphql) y
|
||||
|
||||
4
libs/api/tracker/presenters/src/lib/common/viewer.ts
Normal file
4
libs/api/tracker/presenters/src/lib/common/viewer.ts
Normal file
@@ -0,0 +1,4 @@
|
||||
import { User } from '@task-stream/api/identity/domain';
|
||||
|
||||
/** Who reads: the user's id, or null when anonymous (public projects only). */
|
||||
export const viewerOf = (me: User | undefined): string | null => me?.id ?? null;
|
||||
@@ -41,6 +41,14 @@ export class CreateProjectInput {
|
||||
@IsString()
|
||||
@MaxLength(5000)
|
||||
description?: string | null;
|
||||
|
||||
@Field({
|
||||
nullable: true,
|
||||
description: 'Readable by anyone, also without signing in',
|
||||
})
|
||||
@IsOptional()
|
||||
@IsBoolean()
|
||||
isPublic?: boolean;
|
||||
}
|
||||
|
||||
@InputType()
|
||||
@@ -57,6 +65,10 @@ export class UpdateProjectInput {
|
||||
@IsString()
|
||||
@MaxLength(5000)
|
||||
description?: string | null;
|
||||
@Field({ nullable: true })
|
||||
@IsOptional()
|
||||
@IsBoolean()
|
||||
isPublic?: boolean;
|
||||
}
|
||||
|
||||
@InputType()
|
||||
|
||||
@@ -9,7 +9,10 @@ import {
|
||||
Resolver,
|
||||
} from '@nestjs/graphql';
|
||||
import { User } from '@task-stream/api/identity/domain';
|
||||
import { CurrentUser } from '@task-stream/api/identity/presenters';
|
||||
import {
|
||||
CurrentUser,
|
||||
OptionalAuth,
|
||||
} from '@task-stream/api/identity/presenters';
|
||||
import {
|
||||
CommentsService,
|
||||
IssuesService,
|
||||
@@ -27,6 +30,7 @@ import {
|
||||
UpdateIssueInput,
|
||||
} from './inputs';
|
||||
import { withoutNulls } from '../common/issue-input';
|
||||
import { viewerOf } from '../common/viewer';
|
||||
import {
|
||||
ActivityGql,
|
||||
CommandResultGql,
|
||||
@@ -43,23 +47,29 @@ export class IssueResolver {
|
||||
private readonly workflows: WorkflowsService,
|
||||
) {}
|
||||
|
||||
@OptionalAuth()
|
||||
@Query(() => IssueGql)
|
||||
issue(
|
||||
@CurrentUser() me: User,
|
||||
@CurrentUser() me: User | undefined,
|
||||
@Args('idOrKey', { description: 'Issue id or key (e.g. "TS-42")' })
|
||||
idOrKey: string,
|
||||
) {
|
||||
return this.issuesService.findOne(me.id, idOrKey);
|
||||
return this.issuesService.findOne(viewerOf(me), idOrKey);
|
||||
}
|
||||
|
||||
@OptionalAuth()
|
||||
@Query(() => IssuePageGql, { name: 'issues' })
|
||||
searchIssues(
|
||||
@CurrentUser() me: User,
|
||||
@CurrentUser() me: User | undefined,
|
||||
@Args('filter') filter: IssueFilterInput,
|
||||
@Args('limit', { type: () => Int, defaultValue: 50 }) limit: number,
|
||||
@Args('offset', { type: () => Int, defaultValue: 0 }) offset: number,
|
||||
) {
|
||||
return this.issuesService.search(me.id, { ...filter, limit, offset });
|
||||
return this.issuesService.search(viewerOf(me), {
|
||||
...filter,
|
||||
limit,
|
||||
offset,
|
||||
});
|
||||
}
|
||||
|
||||
@Query(() => IssuePageGql, {
|
||||
@@ -85,18 +95,19 @@ export class IssueResolver {
|
||||
});
|
||||
}
|
||||
|
||||
@OptionalAuth()
|
||||
@Query(() => [ActivityGql], {
|
||||
description: 'Project activity feed (newest first)',
|
||||
})
|
||||
activity(
|
||||
@CurrentUser() me: User,
|
||||
@CurrentUser() me: User | undefined,
|
||||
@Args('projectId', { type: () => ID }) projectId: string,
|
||||
@Args('issueId', { type: () => ID, nullable: true }) issueId?: string,
|
||||
@Args('limit', { type: () => Int, defaultValue: 50 }) limit = 50,
|
||||
@Args('before', { nullable: true, description: 'ISO date cursor' })
|
||||
before?: string,
|
||||
) {
|
||||
return this.issuesService.activity(me.id, {
|
||||
return this.issuesService.activity(viewerOf(me), {
|
||||
projectId,
|
||||
issueId,
|
||||
limit,
|
||||
@@ -112,31 +123,34 @@ export class IssueResolver {
|
||||
}
|
||||
|
||||
@ResolveField(() => [IssueGql], { description: 'Linked tickets I can see' })
|
||||
linkedIssues(@CurrentUser() me: User, @Parent() issue: IssueReadModel) {
|
||||
linkedIssues(
|
||||
@CurrentUser() me: User | undefined,
|
||||
@Parent() issue: IssueReadModel,
|
||||
) {
|
||||
if (issue.links.length === 0) return [];
|
||||
return this.issuesService.findMany(
|
||||
me.id,
|
||||
viewerOf(me),
|
||||
issue.links.map((l) => l.issueId),
|
||||
);
|
||||
}
|
||||
|
||||
@ResolveField(() => CommentPageGql)
|
||||
comments(
|
||||
@CurrentUser() me: User,
|
||||
@CurrentUser() me: User | undefined,
|
||||
@Parent() issue: IssueReadModel,
|
||||
@Args('limit', { type: () => Int, defaultValue: 50 }) limit: number,
|
||||
@Args('offset', { type: () => Int, defaultValue: 0 }) offset: number,
|
||||
) {
|
||||
return this.commentsService.list(me.id, issue.id, limit, offset);
|
||||
return this.commentsService.list(viewerOf(me), issue.id, limit, offset);
|
||||
}
|
||||
|
||||
@ResolveField(() => [ActivityGql], { description: 'History of this ticket' })
|
||||
history(
|
||||
@CurrentUser() me: User,
|
||||
@CurrentUser() me: User | undefined,
|
||||
@Parent() issue: IssueReadModel,
|
||||
@Args('limit', { type: () => Int, defaultValue: 50 }) limit: number,
|
||||
) {
|
||||
return this.issuesService.activity(me.id, {
|
||||
return this.issuesService.activity(viewerOf(me), {
|
||||
projectId: issue.projectId,
|
||||
issueId: issue.id,
|
||||
limit,
|
||||
|
||||
@@ -9,9 +9,14 @@ import {
|
||||
Resolver,
|
||||
} from '@nestjs/graphql';
|
||||
import { User } from '@task-stream/api/identity/domain';
|
||||
import { AccessToken, CurrentUser } from '@task-stream/api/identity/presenters';
|
||||
import {
|
||||
AccessToken,
|
||||
CurrentUser,
|
||||
OptionalAuth,
|
||||
} from '@task-stream/api/identity/presenters';
|
||||
import { ProjectsService } from '@task-stream/api/tracker/application';
|
||||
import { ProjectReadModel } from '@task-stream/api/tracker/domain';
|
||||
import { viewerOf } from '../common/viewer';
|
||||
import { fromSettingsPayload, toSettingsPayload } from '../common/settings';
|
||||
import {
|
||||
CreateProjectInput,
|
||||
@@ -38,13 +43,24 @@ export class ProjectResolver {
|
||||
return this.projects.findMine(me.id);
|
||||
}
|
||||
|
||||
@Query(() => ProjectGql)
|
||||
@OptionalAuth()
|
||||
@Query(() => ProjectGql, {
|
||||
description: 'A project of mine, or any public one (no sign-in needed)',
|
||||
})
|
||||
project(
|
||||
@CurrentUser() me: User,
|
||||
@CurrentUser() me: User | undefined,
|
||||
@Args('idOrKey', { description: 'Project id or key (e.g. "TS")' })
|
||||
idOrKey: string,
|
||||
) {
|
||||
return this.projects.findOne(me.id, idOrKey);
|
||||
return this.projects.findOne(viewerOf(me), idOrKey);
|
||||
}
|
||||
|
||||
@OptionalAuth()
|
||||
@Query(() => [ProjectGql], {
|
||||
description: 'Projects anyone can read, also without signing in',
|
||||
})
|
||||
publicProjects() {
|
||||
return this.projects.findPublic();
|
||||
}
|
||||
|
||||
@ResolveField(() => ProjectSettingsGql)
|
||||
@@ -57,30 +73,36 @@ export class ProjectResolver {
|
||||
'Statistics of the last `days` days (7-365): created vs resolved, cumulative flow, cycle/lead time, throughput and QA',
|
||||
})
|
||||
analytics(
|
||||
@CurrentUser() me: User,
|
||||
@CurrentUser() me: User | undefined,
|
||||
@Parent() project: ProjectReadModel,
|
||||
@Args('days', { type: () => Int, defaultValue: 90 }) days: number,
|
||||
) {
|
||||
return this.projects.analytics(me.id, project.id, days);
|
||||
return this.projects.analytics(viewerOf(me), project.id, days);
|
||||
}
|
||||
|
||||
@ResolveField(() => [ReleaseGql])
|
||||
releases(@CurrentUser() me: User, @Parent() project: ProjectReadModel) {
|
||||
return this.projects.releases(me.id, project.id);
|
||||
releases(
|
||||
@CurrentUser() me: User | undefined,
|
||||
@Parent() project: ProjectReadModel,
|
||||
) {
|
||||
return this.projects.releases(viewerOf(me), project.id);
|
||||
}
|
||||
|
||||
@ResolveField(() => ProjectStatsGql, {
|
||||
description: 'Project tracking dashboard',
|
||||
})
|
||||
stats(@CurrentUser() me: User, @Parent() project: ProjectReadModel) {
|
||||
return this.projects.stats(me.id, project.id);
|
||||
stats(
|
||||
@CurrentUser() me: User | undefined,
|
||||
@Parent() project: ProjectReadModel,
|
||||
) {
|
||||
return this.projects.stats(viewerOf(me), project.id);
|
||||
}
|
||||
|
||||
@ResolveField(() => [BoardColumnGql], {
|
||||
description: 'Kanban board, one column per status',
|
||||
})
|
||||
board(
|
||||
@CurrentUser() me: User,
|
||||
@CurrentUser() me: User | undefined,
|
||||
@Parent() project: ProjectReadModel,
|
||||
@Args('releaseId', { type: () => ID, nullable: true }) releaseId?: string,
|
||||
@Args('assigneeId', { type: () => ID, nullable: true }) assigneeId?: string,
|
||||
@@ -88,7 +110,7 @@ export class ProjectResolver {
|
||||
@Args('perColumn', { type: () => Int, defaultValue: 50 }) perColumn = 50,
|
||||
) {
|
||||
return this.projects.board(
|
||||
me.id,
|
||||
viewerOf(me),
|
||||
{
|
||||
projectId: project.id,
|
||||
releaseId,
|
||||
@@ -132,6 +154,18 @@ export class ProjectResolver {
|
||||
);
|
||||
}
|
||||
|
||||
@Mutation(() => CommandResultGql, {
|
||||
description:
|
||||
'Delete the project (owner only), with its tickets, comments and releases. `confirmKey` must be the project key.',
|
||||
})
|
||||
deleteProject(
|
||||
@CurrentUser() me: User,
|
||||
@Args('projectId', { type: () => ID }) projectId: string,
|
||||
@Args('confirmKey') confirmKey: string,
|
||||
) {
|
||||
return this.projects.delete(me.id, projectId, confirmKey);
|
||||
}
|
||||
|
||||
@Mutation(() => CommandResultGql, {
|
||||
description: 'Add a Pireon user to the project',
|
||||
})
|
||||
|
||||
@@ -10,7 +10,11 @@ import {
|
||||
} from '@nestjs/graphql';
|
||||
import { User } from '@task-stream/api/identity/domain';
|
||||
import { ReleaseReadModel } from '@task-stream/api/tracker/domain';
|
||||
import { CurrentUser } from '@task-stream/api/identity/presenters';
|
||||
import {
|
||||
CurrentUser,
|
||||
OptionalAuth,
|
||||
} from '@task-stream/api/identity/presenters';
|
||||
import { viewerOf } from '../common/viewer';
|
||||
import {
|
||||
IssuesService,
|
||||
ReleasesService,
|
||||
@@ -31,9 +35,13 @@ export class ReleaseResolver {
|
||||
private readonly issuesService: IssuesService,
|
||||
) {}
|
||||
|
||||
@OptionalAuth()
|
||||
@Query(() => ReleaseGql)
|
||||
release(@CurrentUser() me: User, @Args('id', { type: () => ID }) id: string) {
|
||||
return this.releases.findOne(me.id, id);
|
||||
release(
|
||||
@CurrentUser() me: User | undefined,
|
||||
@Args('id', { type: () => ID }) id: string,
|
||||
) {
|
||||
return this.releases.findOne(viewerOf(me), id);
|
||||
}
|
||||
|
||||
@Query(() => [ReleaseGql], {
|
||||
@@ -48,27 +56,33 @@ export class ReleaseResolver {
|
||||
}
|
||||
|
||||
@ResolveField(() => ReleaseProgressGql)
|
||||
progress(@CurrentUser() me: User, @Parent() release: ReleaseReadModel) {
|
||||
return this.releases.progress(me.id, release.id);
|
||||
progress(
|
||||
@CurrentUser() me: User | undefined,
|
||||
@Parent() release: ReleaseReadModel,
|
||||
) {
|
||||
return this.releases.progress(viewerOf(me), release.id);
|
||||
}
|
||||
|
||||
@ResolveField(() => ReleaseBurnupGql, {
|
||||
description: 'Scope vs finished tickets, day by day',
|
||||
})
|
||||
burnup(@CurrentUser() me: User, @Parent() release: ReleaseReadModel) {
|
||||
return this.releases.burnup(me.id, release.id);
|
||||
burnup(
|
||||
@CurrentUser() me: User | undefined,
|
||||
@Parent() release: ReleaseReadModel,
|
||||
) {
|
||||
return this.releases.burnup(viewerOf(me), release.id);
|
||||
}
|
||||
|
||||
@ResolveField(() => IssuePageGql, {
|
||||
description: 'Tickets included in this release',
|
||||
})
|
||||
issues(
|
||||
@CurrentUser() me: User,
|
||||
@CurrentUser() me: User | undefined,
|
||||
@Parent() release: ReleaseReadModel,
|
||||
@Args('limit', { type: () => Int, defaultValue: 100 }) limit: number,
|
||||
@Args('offset', { type: () => Int, defaultValue: 0 }) offset: number,
|
||||
) {
|
||||
return this.issuesService.search(me.id, {
|
||||
return this.issuesService.search(viewerOf(me), {
|
||||
projectId: release.projectId,
|
||||
releaseId: release.id,
|
||||
limit,
|
||||
|
||||
@@ -71,6 +71,8 @@ export class ProjectGql {
|
||||
@Field() key!: string;
|
||||
@Field() name!: string;
|
||||
@Field(() => String, { nullable: true }) description!: string | null;
|
||||
@Field({ description: 'Anyone can read it, also without signing in' })
|
||||
isPublic!: boolean;
|
||||
@Field(() => UserRefGql) owner!: UserRefGql;
|
||||
@Field(() => [ProjectMemberGql]) members!: ProjectMemberGql[];
|
||||
@Field() createdAt!: string;
|
||||
|
||||
@@ -73,12 +73,30 @@ export class CreateProjectDto {
|
||||
@IsString()
|
||||
@MaxLength(5000)
|
||||
description?: string | null;
|
||||
|
||||
@ApiPropertyOptional({
|
||||
default: false,
|
||||
description:
|
||||
'Anyone can read it without signing in (board, tickets, comments, releases, activity, statistics)',
|
||||
})
|
||||
@IsOptional()
|
||||
@IsBoolean()
|
||||
isPublic?: boolean;
|
||||
}
|
||||
|
||||
export class UpdateProjectDto extends PartialType(
|
||||
OmitType(CreateProjectDto, ['key'] as const),
|
||||
) {}
|
||||
|
||||
export class DeleteProjectQueryDto {
|
||||
@ApiProperty({
|
||||
example: 'WEB',
|
||||
description: 'The project key, to confirm the deletion',
|
||||
})
|
||||
@IsString()
|
||||
confirm!: string;
|
||||
}
|
||||
|
||||
export class AddMemberDto {
|
||||
@ApiProperty({ description: 'Pireon user id (see GET /users)' })
|
||||
@IsString()
|
||||
|
||||
@@ -76,6 +76,8 @@ export class ProjectDto {
|
||||
key!: string;
|
||||
@ApiProperty({ example: 'Checkout revamp' }) name!: string;
|
||||
@ApiProperty({ type: String, nullable: true }) description!: string | null;
|
||||
@ApiProperty({ description: 'Readable by anyone, also without a token' })
|
||||
isPublic!: boolean;
|
||||
@ApiProperty({ type: UserRefDto }) owner!: UserRefDto;
|
||||
@ApiProperty({ type: [ProjectMemberDto] }) members!: ProjectMemberDto[];
|
||||
@ApiProperty({ type: ProjectSettingsDto })
|
||||
|
||||
@@ -0,0 +1,25 @@
|
||||
import { Controller, Get } from '@nestjs/common';
|
||||
import { ApiOkResponse, ApiOperation, ApiTags } from '@nestjs/swagger';
|
||||
import { Public } from '@task-stream/api/identity/presenters';
|
||||
import { ProjectsService } from '@task-stream/api/tracker/application';
|
||||
import { ProjectDto } from './dto/responses.dto';
|
||||
import { toProjectDto } from './refs';
|
||||
|
||||
/** What anyone can read without signing in. */
|
||||
@ApiTags('Explore')
|
||||
@Controller('explore')
|
||||
export class ExploreController {
|
||||
constructor(private readonly projects: ProjectsService) {}
|
||||
|
||||
@Get('projects')
|
||||
@Public()
|
||||
@ApiOperation({
|
||||
summary: 'Public projects (no token needed)',
|
||||
description:
|
||||
'Their board, tickets, comments, releases, activity and statistics can be read without a token too.',
|
||||
})
|
||||
@ApiOkResponse({ type: [ProjectDto] })
|
||||
async publicProjects() {
|
||||
return (await this.projects.findPublic()).map(toProjectDto);
|
||||
}
|
||||
}
|
||||
@@ -18,6 +18,7 @@ import {
|
||||
} from '@nestjs/swagger';
|
||||
import { User } from '@task-stream/api/identity/domain';
|
||||
import {
|
||||
ApiOptionalPireonAuth,
|
||||
ApiPireonAuth,
|
||||
CurrentUser,
|
||||
} from '@task-stream/api/identity/presenters';
|
||||
@@ -51,6 +52,7 @@ import {
|
||||
IssueDto,
|
||||
IssuePageDto,
|
||||
} from './dto/responses.dto';
|
||||
import { viewerOf } from '../common/viewer';
|
||||
import { Refs } from './refs';
|
||||
|
||||
const PROJECT = ApiParam({
|
||||
@@ -95,17 +97,18 @@ export class IssuesController {
|
||||
}
|
||||
|
||||
@Get('projects/:project/issues')
|
||||
@ApiOptionalPireonAuth()
|
||||
@PROJECT
|
||||
@ApiOperation({ summary: 'Search the tickets of a project' })
|
||||
@ApiOkResponse({ type: IssuePageDto })
|
||||
@ApiReadErrors()
|
||||
async search(
|
||||
@CurrentUser() me: User,
|
||||
@CurrentUser() me: User | undefined,
|
||||
@Param('project') project: string,
|
||||
@Query() query: IssueSearchQueryDto,
|
||||
) {
|
||||
const page = await this.issues.search(me.id, {
|
||||
projectId: await this.refs.projectId(me.id, project),
|
||||
const page = await this.issues.search(viewerOf(me), {
|
||||
projectId: await this.refs.projectId(viewerOf(me), project),
|
||||
statuses: query.status,
|
||||
categories: query.category,
|
||||
types: query.type,
|
||||
@@ -143,12 +146,16 @@ export class IssuesController {
|
||||
}
|
||||
|
||||
@Get('issues/:issue')
|
||||
@ApiOptionalPireonAuth()
|
||||
@ISSUE
|
||||
@ApiOperation({ summary: 'A ticket' })
|
||||
@ApiOkResponse({ type: IssueDto })
|
||||
@ApiReadErrors()
|
||||
async findOne(@CurrentUser() me: User, @Param('issue') issue: string) {
|
||||
return this.refs.issueDto(await this.issues.findOne(me.id, issue));
|
||||
async findOne(
|
||||
@CurrentUser() me: User | undefined,
|
||||
@Param('issue') issue: string,
|
||||
) {
|
||||
return this.refs.issueDto(await this.issues.findOne(viewerOf(me), issue));
|
||||
}
|
||||
|
||||
@Patch('issues/:issue')
|
||||
@@ -271,18 +278,19 @@ export class IssuesController {
|
||||
}
|
||||
|
||||
@Get('issues/:issue/comments')
|
||||
@ApiOptionalPireonAuth()
|
||||
@ISSUE
|
||||
@ApiOperation({ summary: 'Comments of the ticket (oldest first)' })
|
||||
@ApiOkResponse({ type: CommentPageDto })
|
||||
@ApiReadErrors()
|
||||
async listComments(
|
||||
@CurrentUser() me: User,
|
||||
@CurrentUser() me: User | undefined,
|
||||
@Param('issue') issue: string,
|
||||
@Query() page: PageQueryDto,
|
||||
) {
|
||||
return this.comments.list(
|
||||
me.id,
|
||||
await this.refs.issueId(me.id, issue),
|
||||
viewerOf(me),
|
||||
await this.refs.issueId(viewerOf(me), issue),
|
||||
page.limit,
|
||||
page.offset,
|
||||
);
|
||||
@@ -306,17 +314,18 @@ export class IssuesController {
|
||||
}
|
||||
|
||||
@Get('issues/:issue/history')
|
||||
@ApiOptionalPireonAuth()
|
||||
@ISSUE
|
||||
@ApiOperation({ summary: 'History of the ticket (newest first)' })
|
||||
@ApiOkResponse({ type: [ActivityDto] })
|
||||
@ApiReadErrors()
|
||||
async history(
|
||||
@CurrentUser() me: User,
|
||||
@CurrentUser() me: User | undefined,
|
||||
@Param('issue') issue: string,
|
||||
@Query() page: PageQueryDto,
|
||||
) {
|
||||
const found = await this.issues.findOne(me.id, issue);
|
||||
return this.issues.activity(me.id, {
|
||||
const found = await this.issues.findOne(viewerOf(me), issue);
|
||||
return this.issues.activity(viewerOf(me), {
|
||||
projectId: found.projectId,
|
||||
issueId: found.id,
|
||||
limit: page.limit,
|
||||
|
||||
@@ -19,6 +19,7 @@ import {
|
||||
import { User } from '@task-stream/api/identity/domain';
|
||||
import {
|
||||
AccessToken,
|
||||
ApiOptionalPireonAuth,
|
||||
ApiPireonAuth,
|
||||
CurrentUser,
|
||||
} from '@task-stream/api/identity/presenters';
|
||||
@@ -37,6 +38,7 @@ import {
|
||||
BoardQueryDto,
|
||||
ChangeMemberRoleDto,
|
||||
CreateProjectDto,
|
||||
DeleteProjectQueryDto,
|
||||
ProjectSettingsBodyDto,
|
||||
UpdateProjectDto,
|
||||
} from './dto/requests.dto';
|
||||
@@ -49,6 +51,7 @@ import {
|
||||
ProjectStatsDto,
|
||||
} from './dto/responses.dto';
|
||||
import { fromSettingsPayload } from '../common/settings';
|
||||
import { viewerOf } from '../common/viewer';
|
||||
import { Refs, toProjectDto } from './refs';
|
||||
|
||||
const PROJECT = ApiParam({
|
||||
@@ -85,17 +88,23 @@ export class ProjectsController {
|
||||
}
|
||||
|
||||
@Get(':project')
|
||||
@ApiOptionalPireonAuth()
|
||||
@PROJECT
|
||||
@ApiOperation({ summary: 'A project with its members and settings' })
|
||||
@ApiOkResponse({ type: ProjectDto })
|
||||
@ApiReadErrors()
|
||||
async findOne(@CurrentUser() me: User, @Param('project') project: string) {
|
||||
return toProjectDto(await this.projects.findOne(me.id, project));
|
||||
async findOne(
|
||||
@CurrentUser() me: User | undefined,
|
||||
@Param('project') project: string,
|
||||
) {
|
||||
return toProjectDto(await this.projects.findOne(viewerOf(me), project));
|
||||
}
|
||||
|
||||
@Patch(':project')
|
||||
@PROJECT
|
||||
@ApiOperation({ summary: 'Rename or describe a project (owner/admin)' })
|
||||
@ApiOperation({
|
||||
summary: 'Rename, describe or make public/private a project (owner/admin)',
|
||||
})
|
||||
@ApiOkResponse({ type: CommandResultDto })
|
||||
@ApiCommandErrors()
|
||||
async update(
|
||||
@@ -110,6 +119,29 @@ export class ProjectsController {
|
||||
);
|
||||
}
|
||||
|
||||
@Delete(':project')
|
||||
@PROJECT
|
||||
@ApiOperation({
|
||||
summary: 'Delete a project (owner only)',
|
||||
description:
|
||||
'Deletes the project and, right after (asynchronously, through a saga), its tickets, comments and releases; ' +
|
||||
'links from tickets of other projects are removed and the key becomes free. Cannot be undone from the API. ' +
|
||||
'`confirm` must be the project key.',
|
||||
})
|
||||
@ApiOkResponse({ type: CommandResultDto })
|
||||
@ApiCommandErrors()
|
||||
async remove(
|
||||
@CurrentUser() me: User,
|
||||
@Param('project') project: string,
|
||||
@Query() query: DeleteProjectQueryDto,
|
||||
) {
|
||||
return this.projects.delete(
|
||||
me.id,
|
||||
await this.refs.projectId(me.id, project),
|
||||
query.confirm,
|
||||
);
|
||||
}
|
||||
|
||||
@Put(':project/settings')
|
||||
@PROJECT
|
||||
@ApiOperation({
|
||||
@@ -133,19 +165,20 @@ export class ProjectsController {
|
||||
}
|
||||
|
||||
@Get(':project/board')
|
||||
@ApiOptionalPireonAuth()
|
||||
@PROJECT
|
||||
@ApiOperation({ summary: 'Kanban board: one column per status' })
|
||||
@ApiOkResponse({ type: [BoardColumnDto] })
|
||||
@ApiReadErrors()
|
||||
async board(
|
||||
@CurrentUser() me: User,
|
||||
@CurrentUser() me: User | undefined,
|
||||
@Param('project') project: string,
|
||||
@Query() query: BoardQueryDto,
|
||||
) {
|
||||
const columns = await this.projects.board(
|
||||
me.id,
|
||||
viewerOf(me),
|
||||
{
|
||||
projectId: await this.refs.projectId(me.id, project),
|
||||
projectId: await this.refs.projectId(viewerOf(me), project),
|
||||
releaseId: query.releaseId,
|
||||
assigneeId: query.assigneeId,
|
||||
areas: query.area ? [query.area] : undefined,
|
||||
@@ -161,20 +194,25 @@ export class ProjectsController {
|
||||
}
|
||||
|
||||
@Get(':project/stats')
|
||||
@ApiOptionalPireonAuth()
|
||||
@PROJECT
|
||||
@ApiOperation({
|
||||
summary: 'Tracking dashboard: counts by status, type, person…',
|
||||
})
|
||||
@ApiOkResponse({ type: ProjectStatsDto })
|
||||
@ApiReadErrors()
|
||||
async stats(@CurrentUser() me: User, @Param('project') project: string) {
|
||||
async stats(
|
||||
@CurrentUser() me: User | undefined,
|
||||
@Param('project') project: string,
|
||||
) {
|
||||
return this.projects.stats(
|
||||
me.id,
|
||||
await this.refs.projectId(me.id, project),
|
||||
viewerOf(me),
|
||||
await this.refs.projectId(viewerOf(me), project),
|
||||
);
|
||||
}
|
||||
|
||||
@Get(':project/analytics')
|
||||
@ApiOptionalPireonAuth()
|
||||
@PROJECT
|
||||
@ApiOperation({
|
||||
summary: 'Statistics of the last `days` days',
|
||||
@@ -184,29 +222,30 @@ export class ProjectsController {
|
||||
@ApiOkResponse({ type: ProjectAnalyticsDto })
|
||||
@ApiReadErrors()
|
||||
async analytics(
|
||||
@CurrentUser() me: User,
|
||||
@CurrentUser() me: User | undefined,
|
||||
@Param('project') project: string,
|
||||
@Query() query: AnalyticsQueryDto,
|
||||
) {
|
||||
return this.projects.analytics(
|
||||
me.id,
|
||||
await this.refs.projectId(me.id, project),
|
||||
viewerOf(me),
|
||||
await this.refs.projectId(viewerOf(me), project),
|
||||
query.days,
|
||||
);
|
||||
}
|
||||
|
||||
@Get(':project/activity')
|
||||
@ApiOptionalPireonAuth()
|
||||
@PROJECT
|
||||
@ApiOperation({ summary: 'Activity feed (newest first)' })
|
||||
@ApiOkResponse({ type: [ActivityDto] })
|
||||
@ApiReadErrors()
|
||||
async activity(
|
||||
@CurrentUser() me: User,
|
||||
@CurrentUser() me: User | undefined,
|
||||
@Param('project') project: string,
|
||||
@Query() query: ActivityQueryDto,
|
||||
) {
|
||||
return this.issues.activity(me.id, {
|
||||
projectId: await this.refs.projectId(me.id, project),
|
||||
return this.issues.activity(viewerOf(me), {
|
||||
projectId: await this.refs.projectId(viewerOf(me), project),
|
||||
issueId: query.issueId,
|
||||
limit: query.limit,
|
||||
before: query.before,
|
||||
|
||||
@@ -25,12 +25,12 @@ export class Refs {
|
||||
private readonly workflows: WorkflowsService,
|
||||
) {}
|
||||
|
||||
async projectId(viewerId: string, ref: string): Promise<string> {
|
||||
async projectId(viewerId: string | null, ref: string): Promise<string> {
|
||||
if (UUID.test(ref)) return ref;
|
||||
return (await this.projects.findOne(viewerId, ref)).id;
|
||||
}
|
||||
|
||||
async issueId(viewerId: string, ref: string): Promise<string> {
|
||||
async issueId(viewerId: string | null, ref: string): Promise<string> {
|
||||
if (UUID.test(ref)) return ref;
|
||||
return (await this.issues.findOne(viewerId, ref)).id;
|
||||
}
|
||||
|
||||
@@ -17,6 +17,7 @@ import {
|
||||
} from '@nestjs/swagger';
|
||||
import { User } from '@task-stream/api/identity/domain';
|
||||
import {
|
||||
ApiOptionalPireonAuth,
|
||||
ApiPireonAuth,
|
||||
CurrentUser,
|
||||
} from '@task-stream/api/identity/presenters';
|
||||
@@ -43,6 +44,7 @@ import {
|
||||
ReleaseBurnupDto,
|
||||
ReleaseProgressDto,
|
||||
} from './dto/responses.dto';
|
||||
import { viewerOf } from '../common/viewer';
|
||||
import { Refs } from './refs';
|
||||
|
||||
const PROJECT = ApiParam({
|
||||
@@ -74,14 +76,18 @@ export class ReleasesController {
|
||||
}
|
||||
|
||||
@Get('projects/:project/releases')
|
||||
@ApiOptionalPireonAuth()
|
||||
@PROJECT
|
||||
@ApiOperation({ summary: 'Releases of a project' })
|
||||
@ApiOkResponse({ type: [ReleaseDto] })
|
||||
@ApiReadErrors()
|
||||
async list(@CurrentUser() me: User, @Param('project') project: string) {
|
||||
async list(
|
||||
@CurrentUser() me: User | undefined,
|
||||
@Param('project') project: string,
|
||||
) {
|
||||
return this.projects.releases(
|
||||
me.id,
|
||||
await this.refs.projectId(me.id, project),
|
||||
viewerOf(me),
|
||||
await this.refs.projectId(viewerOf(me), project),
|
||||
);
|
||||
}
|
||||
|
||||
@@ -102,11 +108,15 @@ export class ReleasesController {
|
||||
}
|
||||
|
||||
@Get('releases/:releaseId')
|
||||
@ApiOptionalPireonAuth()
|
||||
@ApiOperation({ summary: 'A release' })
|
||||
@ApiOkResponse({ type: ReleaseDto })
|
||||
@ApiReadErrors()
|
||||
findOne(@CurrentUser() me: User, @Param('releaseId') releaseId: string) {
|
||||
return this.releases.findOne(me.id, releaseId);
|
||||
findOne(
|
||||
@CurrentUser() me: User | undefined,
|
||||
@Param('releaseId') releaseId: string,
|
||||
) {
|
||||
return this.releases.findOne(viewerOf(me), releaseId);
|
||||
}
|
||||
|
||||
@Patch('releases/:releaseId')
|
||||
@@ -122,34 +132,43 @@ export class ReleasesController {
|
||||
}
|
||||
|
||||
@Get('releases/:releaseId/progress')
|
||||
@ApiOptionalPireonAuth()
|
||||
@ApiOperation({ summary: 'Finished tickets out of the total' })
|
||||
@ApiOkResponse({ type: ReleaseProgressDto })
|
||||
@ApiReadErrors()
|
||||
progress(@CurrentUser() me: User, @Param('releaseId') releaseId: string) {
|
||||
return this.releases.progress(me.id, releaseId);
|
||||
progress(
|
||||
@CurrentUser() me: User | undefined,
|
||||
@Param('releaseId') releaseId: string,
|
||||
) {
|
||||
return this.releases.progress(viewerOf(me), releaseId);
|
||||
}
|
||||
|
||||
@Get('releases/:releaseId/burnup')
|
||||
@ApiOptionalPireonAuth()
|
||||
@ApiOperation({
|
||||
summary: 'Burnup: tickets in the release and finished ones, day by day',
|
||||
})
|
||||
@ApiOkResponse({ type: ReleaseBurnupDto })
|
||||
@ApiReadErrors()
|
||||
burnup(@CurrentUser() me: User, @Param('releaseId') releaseId: string) {
|
||||
return this.releases.burnup(me.id, releaseId);
|
||||
burnup(
|
||||
@CurrentUser() me: User | undefined,
|
||||
@Param('releaseId') releaseId: string,
|
||||
) {
|
||||
return this.releases.burnup(viewerOf(me), releaseId);
|
||||
}
|
||||
|
||||
@Get('releases/:releaseId/issues')
|
||||
@ApiOptionalPireonAuth()
|
||||
@ApiOperation({ summary: 'Tickets included in the release' })
|
||||
@ApiOkResponse({ type: IssuePageDto })
|
||||
@ApiReadErrors()
|
||||
async issuesOf(
|
||||
@CurrentUser() me: User,
|
||||
@CurrentUser() me: User | undefined,
|
||||
@Param('releaseId') releaseId: string,
|
||||
@Query() page: PageQueryDto,
|
||||
) {
|
||||
const release = await this.releases.findOne(me.id, releaseId);
|
||||
const found = await this.issues.search(me.id, {
|
||||
const release = await this.releases.findOne(viewerOf(me), releaseId);
|
||||
const found = await this.issues.search(viewerOf(me), {
|
||||
projectId: release.projectId,
|
||||
releaseId: release.id,
|
||||
limit: page.limit,
|
||||
|
||||
@@ -7,6 +7,7 @@ import { ReleaseResolver } from './graphql/release.resolver';
|
||||
import { SubscriptionResolver } from './graphql/subscription.resolver';
|
||||
import { CommentsController } from './http/comments.controller';
|
||||
import { IssuesController } from './http/issues.controller';
|
||||
import { ExploreController } from './http/explore.controller';
|
||||
import { ProjectsController } from './http/projects.controller';
|
||||
import { Refs } from './http/refs';
|
||||
import { ReleasesController } from './http/releases.controller';
|
||||
@@ -22,6 +23,7 @@ import { ReleasesController } from './http/releases.controller';
|
||||
IssuesController,
|
||||
CommentsController,
|
||||
ReleasesController,
|
||||
ExploreController,
|
||||
],
|
||||
providers: [
|
||||
Refs,
|
||||
|
||||
Reference in New Issue
Block a user