jdalrymple/gitbeaker

View on GitHub
packages/core/src/resources/MergeRequestApprovals.ts

Summary

Maintainability
A
2 hrs
Test Coverage
import { BaseResource } from '@gitbeaker/requester-utils';
import { RequestHelper, endpoint } from '../infrastructure';
import type { GitlabAPIResponse, MappedOmit, ShowExpanded, Sudo } from '../infrastructure';
import type { SimpleUserSchema } from './Users';
import type { GroupSchema } from './Groups';
import type { ProtectedBranchSchema } from './ProtectedBranches';

export interface ProjectLevelMergeRequestApprovalSchema extends Record<string, unknown> {
  approvals_before_merge: number;
  reset_approvals_on_push: boolean;
  disable_overriding_approvers_per_merge_request: boolean;
  merge_requests_author_approval: boolean;
  merge_requests_disable_committers_approval: boolean;
  require_password_to_approve: boolean;
}

export interface ApprovedByEntity {
  user: MappedOmit<SimpleUserSchema, 'created_at'>;
}

export interface MergeRequestLevelMergeRequestApprovalSchema extends Record<string, unknown> {
  id: number;
  iid: number;
  project_id: number;
  title: string;
  description: string;
  state: string;
  created_at: string;
  updated_at: string;
  merge_status: string;
  approvals_required: number;
  approvals_left: number;
  approved_by?: ApprovedByEntity[];
}

export interface ApprovalRuleSchema extends Record<string, unknown> {
  id: number;
  name: string;
  rule_type: string;
  eligible_approvers?: MappedOmit<SimpleUserSchema, 'created_at'>[];
  approvals_required: number;
  users?: MappedOmit<SimpleUserSchema, 'created_at'>[];
  groups?: GroupSchema[];
  contains_hidden_groups: boolean;
  overridden: boolean;
}

export interface ProjectLevelApprovalRuleSchema extends ApprovalRuleSchema {
  protected_branches?: ProtectedBranchSchema[];
}

export interface MergeRequestLevelApprovalRuleSchema extends ApprovalRuleSchema {
  source_rule?: string;
}

export interface ApprovalStateSchema extends Record<string, unknown> {
  approval_rules_overwritten: boolean;
  rules: ({ approved: boolean } & MergeRequestLevelApprovalRuleSchema)[];
}

export type CreateApprovalRuleOptions = {
  userIds?: number[];
  groupIds?: number[];
  protectedBranchIds?: number[];
  appliesToAllProtectedBranches?: boolean;
  reportType?: string;
  ruleType?: string;
  usernames?: string[];
};

export type EditApprovalRuleOptions = {
  userIds?: number[];
  groupIds?: number[];
  protectedBranchIds?: number[];
  appliesToAllProtectedBranches?: boolean;
  usernames?: string[];
  removeHiddenGroups?: boolean;
};

export type EditConfigurationOptions = {
  disableOverridingApproversPerMergeRequest?: boolean;
  mergeRequestsAuthorApproval?: boolean;
  mergeRequestsDisableCommittersApproval?: boolean;
  requirePasswordToApprove?: boolean;
  resetApprovalsOnPush?: boolean;
  selectiveCodeOwnerRemovals?: boolean;
};

export class MergeRequestApprovals<C extends boolean = false> extends BaseResource<C> {
  allApprovalRules<E extends boolean = false>(
    projectId: string | number,
    options: { mergerequestIId: number } & Sudo & ShowExpanded<E>,
  ): Promise<GitlabAPIResponse<MergeRequestLevelApprovalRuleSchema[], C, E, void>>;

  allApprovalRules<E extends boolean = false>(
    projectId: string | number,
    options?: Sudo & ShowExpanded<E>,
  ): Promise<GitlabAPIResponse<ProjectLevelApprovalRuleSchema[], C, E, void>>;

  allApprovalRules<E extends boolean = false>(
    projectId: string | number,
    { mergerequestIId, ...options }: { mergerequestIId?: number } & Sudo & ShowExpanded<E> = {},
  ): Promise<
    GitlabAPIResponse<
      (ProjectLevelApprovalRuleSchema | MergeRequestLevelApprovalRuleSchema)[],
      C,
      E,
      void
    >
  > {
    let url: string;

    if (mergerequestIId) {
      url = endpoint`projects/${projectId}/merge_requests/${mergerequestIId}/approval_rules`;
    } else {
      url = endpoint`projects/${projectId}/approval_rules`;
    }

    return RequestHelper.get<
      (ProjectLevelApprovalRuleSchema | MergeRequestLevelApprovalRuleSchema)[]
    >()(this, url, options);
  }

  approve<E extends boolean = false>(
    projectId: string | number,
    mergerequestIId: number,
    options?: { sha?: string; approvalPassword?: string } & Sudo & ShowExpanded<E>,
  ) {
    return RequestHelper.post<MergeRequestLevelMergeRequestApprovalSchema>()(
      this,
      endpoint`projects/${projectId}/merge_requests/${mergerequestIId}/approve`,
      options,
    );
  }

  createApprovalRule<E extends boolean = false>(
    projectId: string | number,
    name: string,
    approvalsRequired: number,
    options: { mergerequestIId: number } & CreateApprovalRuleOptions & Sudo & ShowExpanded<E>,
  ): Promise<GitlabAPIResponse<MergeRequestLevelApprovalRuleSchema, C, E, void>>;

  createApprovalRule<E extends boolean = false>(
    projectId: string | number,
    name: string,
    approvalsRequired: number,
    options?: CreateApprovalRuleOptions & Sudo & ShowExpanded<E>,
  ): Promise<GitlabAPIResponse<ProjectLevelApprovalRuleSchema, C, E, void>>;

  createApprovalRule<E extends boolean = false>(
    projectId: string | number,
    name: string,
    approvalsRequired: number,
    {
      mergerequestIId,
      ...options
    }: { mergerequestIId?: number } & CreateApprovalRuleOptions & Sudo & ShowExpanded<E> = {},
  ): Promise<
    GitlabAPIResponse<
      ProjectLevelApprovalRuleSchema | MergeRequestLevelApprovalRuleSchema,
      C,
      E,
      void
    >
  > {
    let url: string;

    if (mergerequestIId) {
      url = endpoint`projects/${projectId}/merge_requests/${mergerequestIId}/approval_rules`;
    } else {
      url = endpoint`projects/${projectId}/approval_rules`;
    }

    return RequestHelper.post<
      ProjectLevelApprovalRuleSchema | MergeRequestLevelApprovalRuleSchema
    >()(this, url, { name, approvalsRequired, ...options });
  }

  editApprovalRule<E extends boolean = false>(
    projectId: string | number,
    approvalRuleId: number,
    name: string,
    approvalsRequired: number,
    options: { mergerequestIId: number } & EditApprovalRuleOptions & Sudo & ShowExpanded<E>,
  ): Promise<GitlabAPIResponse<MergeRequestLevelApprovalRuleSchema, C, E, void>>;

  editApprovalRule<E extends boolean = false>(
    projectId: string | number,
    approvalRuleId: number,
    name: string,
    approvalsRequired: number,
    options?: EditApprovalRuleOptions & Sudo & ShowExpanded<E>,
  ): Promise<GitlabAPIResponse<ProjectLevelApprovalRuleSchema, C, E, void>>;

  editApprovalRule<E extends boolean = false>(
    projectId: string | number,
    approvalRuleId: number,
    name: string,
    approvalsRequired: number,
    {
      mergerequestIId,
      ...options
    }: { mergerequestIId?: number } & EditApprovalRuleOptions & Sudo & ShowExpanded<E> = {},
  ): Promise<
    GitlabAPIResponse<
      ProjectLevelApprovalRuleSchema | MergeRequestLevelApprovalRuleSchema,
      C,
      E,
      void
    >
  > {
    let url: string;

    if (mergerequestIId) {
      url = endpoint`projects/${projectId}/merge_requests/${mergerequestIId}/approval_rules/${approvalRuleId}`;
    } else {
      url = endpoint`projects/${projectId}/approval_rules/${approvalRuleId}`;
    }

    return RequestHelper.put<
      ProjectLevelApprovalRuleSchema | MergeRequestLevelApprovalRuleSchema
    >()(this, url, { name, approvalsRequired, ...options });
  }

  editConfiguration<E extends boolean = false>(
    projectId: string | number,
    options?: EditConfigurationOptions & Sudo & ShowExpanded<E>,
  ): Promise<GitlabAPIResponse<ProjectLevelMergeRequestApprovalSchema, C, E, void>> {
    return RequestHelper.post<ProjectLevelMergeRequestApprovalSchema>()(
      this,
      endpoint`projects/${projectId}/approvals`,
      options,
    );
  }

  removeApprovalRule<E extends boolean = false>(
    projectId: string | number,
    approvalRuleId: number,
    {
      mergerequestIId,
      ...options
    }: { mergerequestIId?: number } & Sudo & ShowExpanded<E> = {} as any,
  ): Promise<GitlabAPIResponse<void, C, E, void>> {
    let url: string;

    if (mergerequestIId) {
      url = endpoint`projects/${projectId}/merge_requests/${mergerequestIId}/approval_rules/${approvalRuleId}`;
    } else {
      url = endpoint`projects/${projectId}/approval_rules/${approvalRuleId}`;
    }

    return RequestHelper.del()(this, url, options);
  }

  showApprovalRule<E extends boolean = false>(
    projectId: string | number,
    approvalRuleId: number,
    options?: Sudo & ShowExpanded<E>,
  ): Promise<GitlabAPIResponse<ProjectLevelApprovalRuleSchema, C, E, void>> {
    return RequestHelper.get<ProjectLevelApprovalRuleSchema>()(
      this,
      endpoint`projects/${projectId}/approval_rules/${approvalRuleId}`,
      options,
    );
  }

  showApprovalState<E extends boolean = false>(
    projectId: string | number,
    mergerequestIId: number,
    options?: Sudo & ShowExpanded<E>,
  ): Promise<GitlabAPIResponse<ApprovalStateSchema, C, E, void>> {
    return RequestHelper.get<ApprovalStateSchema>()(
      this,
      endpoint`projects/${projectId}/merge_requests/${mergerequestIId}/approval_state`,
      options,
    );
  }

  showConfiguration<E extends boolean = false>(
    projectId: string | number,
    options: { mergerequestIId: number } & Sudo & ShowExpanded<E>,
  ): Promise<GitlabAPIResponse<MergeRequestLevelMergeRequestApprovalSchema, C, E, void>>;

  showConfiguration<E extends boolean = false>(
    projectId: string | number,
    options?: Sudo & ShowExpanded<E>,
  ): Promise<GitlabAPIResponse<ProjectLevelMergeRequestApprovalSchema, C, E, void>>;

  showConfiguration<E extends boolean = false>(
    projectId: string | number,
    { mergerequestIId, ...options }: { mergerequestIId?: number } & Sudo & ShowExpanded<E> = {},
  ): Promise<
    GitlabAPIResponse<
      MergeRequestLevelMergeRequestApprovalSchema | ProjectLevelMergeRequestApprovalSchema,
      C,
      E,
      void
    >
  > {
    let url: string;

    if (mergerequestIId) {
      url = endpoint`projects/${projectId}/merge_requests/${mergerequestIId}/approvals`;
    } else {
      url = endpoint`projects/${projectId}/approvals`;
    }

    return RequestHelper.get<
      MergeRequestLevelMergeRequestApprovalSchema | ProjectLevelMergeRequestApprovalSchema
    >()(this, url, options);
  }

  unapprove<E extends boolean = false>(
    projectId: string | number,
    mergerequestIId: number,
    options?: Sudo & ShowExpanded<E>,
  ): Promise<GitlabAPIResponse<void, C, E, void>> {
    return RequestHelper.post<void>()(
      this,
      endpoint`projects/${projectId}/merge_requests/${mergerequestIId}/unapprove`,
      options,
    );
  }
}