gitbeaker/packages/core/src/resources/DeployTokens.ts

import { BaseResource } from '@gitbeaker/requester-utils';
import { RequestHelper, endpoint } from '../infrastructure';
import type {
  BaseRequestOptions,
  GitlabAPIResponse,
  OneOf,
  OneOrNoneOf,
  PaginationRequestOptions,
  PaginationTypes,
  ShowExpanded,
  Sudo,
} from '../infrastructure';

export type DeployTokenScope =
  | 'read_repository'
  | 'read_registry'
  | 'write_registry'
  | 'read_package_registry'
  | 'write_package_registry';

export interface DeployTokenSchema extends Record<string, unknown> {
  id: number;
  name: string;
  username: string;
  expires_at: string;
  revoked: boolean;
  expired: boolean;
  scopes?: DeployTokenScope[];
}

export class DeployTokens<C extends boolean = false> extends BaseResource<C> {
  all<E extends boolean = false, P extends PaginationTypes = 'offset'>(
    {
      projectId,
      groupId,
      ...options
    }: OneOrNoneOf<{ projectId: string | number; groupId: string | number }> & {
      active?: boolean;
    } & PaginationRequestOptions<P> &
      BaseRequestOptions<E> = {} as any,
  ): Promise<GitlabAPIResponse<DeployTokenSchema[], C, E, P>> {
    let url: string;

    if (projectId) url = endpoint`projects/${projectId}/deploy_tokens`;
    else if (groupId) url = endpoint`groups/${groupId}/deploy_tokens`;
    else url = 'deploy_tokens';

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

  create<E extends boolean = false>(
    name: string,
    scopes: string[],
    {
      projectId,
      groupId,
      ...options
    }: OneOf<{ projectId: string | number; groupId: string | number }> &
      Sudo &
      ShowExpanded<E> = {} as any,
  ): Promise<GitlabAPIResponse<DeployTokenSchema, C, E, void>> {
    let url: string;

    if (projectId) url = endpoint`projects/${projectId}/deploy_tokens`;
    else if (groupId) url = endpoint`groups/${groupId}/deploy_tokens`;
    else {
      throw new Error(
        'Missing required argument. Please supply a projectId or a groupId in the options parameter.',
      );
    }

    return RequestHelper.post<DeployTokenSchema>()(this, url, {
      name,
      scopes,
      ...options,
    });
  }

  remove<E extends boolean = false>(
    tokenId: number,
    {
      projectId,
      groupId,
      ...options
    }: OneOf<{ projectId: string | number; groupId: string | number }> &
      Sudo &
      ShowExpanded<E> = {} as any,
  ): Promise<GitlabAPIResponse<void, C, E, void>> {
    let url: string;

    if (projectId) url = endpoint`projects/${projectId}/deploy_tokens/${tokenId}`;
    else if (groupId) url = endpoint`groups/${groupId}/deploy_tokens/${tokenId}`;
    else {
      throw new Error(
        'Missing required argument. Please supply a projectId or a groupId in the options parameter.',
      );
    }

    return RequestHelper.del()(this, url, options as any as Sudo & ShowExpanded<E>);
  }

  show<E extends boolean = false>(
    tokenId: number,
    {
      projectId,
      groupId,
      ...options
    }: OneOf<{ projectId: string | number; groupId: string | number }> &
      Sudo &
      ShowExpanded<E> = {} as any,
  ): Promise<GitlabAPIResponse<DeployTokenSchema, C, E, void>> {
    let url: string;

    if (projectId) url = endpoint`projects/${projectId}/deploy_tokens/${tokenId}`;
    else if (groupId) url = endpoint`groups/${groupId}/deploy_tokens/${tokenId}`;
    else {
      throw new Error(
        'Missing required argument. Please supply a projectId or a groupId in the options parameter.',
      );
    }

    return RequestHelper.get<DeployTokenSchema>()(
      this,
      url,
      options as any as Sudo & ShowExpanded<E>,
    );
  }
}