DeployKeys.ts

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

export interface CondensedDeployKeySchema extends Record<string, unknown> {
  id: number;
  title: string;
  key: string;
  created_at: string;
}

export interface DeployKeySchema extends CondensedDeployKeySchema {
  fingerprint: string;
  fingerprint_sha256: string;
  expires_at?: string;
  can_push?: boolean;
}

export interface ExpandedDeployKeySchema extends DeployKeySchema {
  projects_with_write_access?: SimpleProjectSchema[];
}

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

    if (projectId) {
      url = endpoint`projects/${projectId}/deploy_keys`;
    } else if (userId) {
      url = endpoint`users/${userId}/project_deploy_keys`;
    } else {
      url = 'deploy_keys';
    }

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

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

  edit<E extends boolean = false>(
    projectId: string | number,
    keyId: number,
    options?: { canPush?: boolean; title?: string } & Sudo & ShowExpanded<E>,
  ): Promise<GitlabAPIResponse<DeployKeySchema, C, E, void>> {
    return RequestHelper.put<DeployKeySchema>()(
      this,
      endpoint`projects/${projectId}/deploy_keys/${keyId}`,
      options,
    );
  }

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

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

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