jdalrymple/gitbeaker

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

Summary

Maintainability
A
0 mins
Test Coverage
import { BaseResource } from '@gitbeaker/requester-utils';
import { RequestHelper, endpoint } from '../infrastructure';
import type { GitlabAPIResponse, ShowExpanded, Sudo } from '../infrastructure';
import type { CommitSchema } from './Commits';

export interface RepositoryFileExpandedSchema extends Record<string, unknown> {
  file_name: string;
  file_path: string;
  size: number;
  encoding: string;
  content: string;
  content_sha256: string;
  ref: string;
  blob_id: string;
  commit_id: string;
  last_commit_id: string;
}

export interface RepositoryFileBlameSchema extends Record<string, unknown> {
  commit: CommitSchema;
  lines?: string[];
}

export interface RepositoryFileSchema extends Record<string, unknown> {
  file_path: string;
  branch: string;
}

export type CreateRepositoryFileOptions = {
  authorEmail?: string;
  authorName?: string;
  encoding?: string;
  executeFilemode?: boolean;
  startBranch?: string;
};

export type EditRepositoryFileOptions = {
  authorEmail?: string;
  authorName?: string;
  encoding?: string;
  executeFilemode?: boolean;
  startBranch?: string;
  lastCommitId?: string;
};

export type RemoveRepositoryFileOptions = {
  authorEmail?: string;
  authorName?: string;
  startBranch?: string;
  lastCommitId?: string;
};

export class RepositoryFiles<C extends boolean = false> extends BaseResource<C> {
  allFileBlames<E extends boolean = false>(
    projectId: string | number,
    filePath: string,
    ref: string,
    options?: { range?: { start: number; end: number } } & Sudo & ShowExpanded<E>,
  ): Promise<GitlabAPIResponse<RepositoryFileBlameSchema[], C, E, void>> {
    return RequestHelper.get<RepositoryFileBlameSchema[]>()(
      this,
      endpoint`projects/${projectId}/repository/files/${filePath}/blame`,
      {
        ref,
        ...options,
      },
    );
  }

  create<E extends boolean = false>(
    projectId: string | number,
    filePath: string,
    branch: string,
    content: string,
    commitMessage: string,
    options?: CreateRepositoryFileOptions & Sudo & ShowExpanded<E>,
  ): Promise<GitlabAPIResponse<RepositoryFileSchema, C, E, void>> {
    return RequestHelper.post<RepositoryFileSchema>()(
      this,
      endpoint`projects/${projectId}/repository/files/${filePath}`,
      {
        branch,
        content,
        commitMessage,
        ...options,
      },
    );
  }

  edit<E extends boolean = false>(
    projectId: string | number,
    filePath: string,
    branch: string,
    content: string,
    commitMessage: string,
    options?: EditRepositoryFileOptions & Sudo & ShowExpanded<E>,
  ): Promise<GitlabAPIResponse<RepositoryFileSchema, C, E, void>> {
    return RequestHelper.put<RepositoryFileSchema>()(
      this,
      endpoint`projects/${projectId}/repository/files/${filePath}`,
      {
        branch,
        content,
        commitMessage,
        ...options,
      },
    );
  }

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

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

  showRaw<E extends boolean = false>(
    projectId: string | number,
    filePath: string,
    ref: string,
    options?: { lfs?: boolean } & Sudo & ShowExpanded<E>,
  ): Promise<GitlabAPIResponse<string | Blob, C, E, void>> {
    return RequestHelper.get<string | Blob>()(
      this,
      endpoint`projects/${projectId}/repository/files/${filePath}/raw`,
      {
        ref,
        ...options,
      },
    );
  }
}