packages/core/src/resources/IssueLinks.ts
import { BaseResource } from '@gitbeaker/requester-utils';
import { RequestHelper, endpoint } from '../infrastructure';
import type {
GitlabAPIResponse,
MappedOmit,
PaginationRequestOptions,
PaginationTypes,
ShowExpanded,
Sudo,
} from '../infrastructure';
import { SimpleUserSchema } from './Users';
import { MilestoneSchema } from '../templates/ResourceMilestones';
export interface IssueLinkSchema extends Record<string, unknown> {
id: number;
iid: number;
project_id: number;
issue_link_id: number;
state: string;
description: string;
weight?: number;
author: MappedOmit<SimpleUserSchema, 'created_at'>;
milestone: MilestoneSchema;
assignees?: MappedOmit<SimpleUserSchema, 'created_at'>[];
title: string;
labels?: string[];
user_notes_count: number;
due_date: string;
web_url: string;
confidential: boolean;
updated_at: string;
link_created_at: string;
link_updated_at: string;
link_type: 'relates_to' | 'blocks' | 'is_blocked_by';
}
export interface ExpandedIssueLinkSchema extends Record<string, unknown> {
source_issue: MappedOmit<
IssueLinkSchema,
'link_type' | 'link_created_at' | 'link_updated_at' | 'issue_link_id'
>;
target_issue: MappedOmit<
IssueLinkSchema,
'link_type' | 'link_created_at' | 'link_updated_at' | 'issue_link_id'
>;
link_type: 'relates_to' | 'blocks' | 'is_blocked_by';
}
export class IssueLinks<C extends boolean = false> extends BaseResource<C> {
all<E extends boolean = false, P extends PaginationTypes = 'offset'>(
projectId: string | number,
issueIId: number,
options?: Sudo & ShowExpanded<E> & PaginationRequestOptions<P>,
): Promise<GitlabAPIResponse<IssueLinkSchema[], C, E, P>> {
return RequestHelper.get<IssueLinkSchema[]>()(
this,
endpoint`projects/${projectId}/issues/${issueIId}/links`,
options,
);
}
create<E extends boolean = false>(
projectId: string | number,
issueIId: number,
targetProjectId: string | number,
targetIssueIId: number,
options?: { linkType?: 'relates_to' | 'blocks' | 'is_blocked_by' } & Sudo & ShowExpanded<E>,
): Promise<GitlabAPIResponse<ExpandedIssueLinkSchema, C, E, void>> {
return RequestHelper.post<ExpandedIssueLinkSchema>()(
this,
endpoint`projects/${projectId}/issues/${issueIId}/links`,
{
targetProjectId,
targetIssueIid: targetIssueIId,
...options,
},
);
}
remove<E extends boolean = false>(
projectId: string | number,
issueIId: number,
issueLinkId: number,
options?: { linkType?: 'relates_to' | 'blocks' | 'is_blocked_by' } & Sudo & ShowExpanded<E>,
): Promise<GitlabAPIResponse<ExpandedIssueLinkSchema, C, E, void>> {
return RequestHelper.del<ExpandedIssueLinkSchema>()(
this,
endpoint`projects/${projectId}/issues/${issueIId}/links/${issueLinkId}`,
options,
);
}
}