@apiclient.xyz/gitlab 2.5.0 → 2.6.0

package/ts/gitlab.classes.group.ts

@@ -0,0 +1,137 @@
+import type { GitLabClient } from './gitlab.classes.gitlabclient.js';
+import type { IGitLabGroup, IListOptions, IVariableOptions } from './gitlab.interfaces.js';
+import { GitLabProject } from './gitlab.classes.project.js';
+import { GitLabVariable } from './gitlab.classes.variable.js';
+import { autoPaginate } from './gitlab.helpers.js';
+
+export class GitLabGroup {
+  // Raw data
+  public readonly id: number;
+  public readonly name: string;
+  public readonly fullPath: string;
+  public readonly description: string;
+  public readonly webUrl: string;
+  public readonly visibility: string;
+
+  /** @internal */
+  constructor(
+    private client: GitLabClient,
+    raw: IGitLabGroup,
+  ) {
+    this.id = raw.id;
+    this.name = raw.name || '';
+    this.fullPath = raw.full_path || '';
+    this.description = raw.description || '';
+    this.webUrl = raw.web_url || '';
+    this.visibility = raw.visibility || 'private';
+  }
+
+  // ---------------------------------------------------------------------------
+  // Projects
+  // ---------------------------------------------------------------------------
+
+  async getProjects(opts?: IListOptions): Promise<GitLabProject[]> {
+    return autoPaginate(
+      (page, perPage) => this.client.requestGetGroupProjects(this.id, { ...opts, page, perPage }),
+      opts,
+    ).then(projects => projects.map(p => new GitLabProject(this.client, p)));
+  }
+
+  // ---------------------------------------------------------------------------
+  // Descendant Groups
+  // ---------------------------------------------------------------------------
+
+  async getDescendantGroups(opts?: IListOptions): Promise<GitLabGroup[]> {
+    return autoPaginate(
+      (page, perPage) => this.client.requestGetDescendantGroups(this.id, { ...opts, page, perPage }),
+      opts,
+    ).then(groups => groups.map(g => new GitLabGroup(this.client, g)));
+  }
+
+  // ---------------------------------------------------------------------------
+  // Variables (CI/CD)
+  // ---------------------------------------------------------------------------
+
+  async getVariables(): Promise<GitLabVariable[]> {
+    const vars = await this.client.requestGetGroupVariables(this.id);
+    return vars.map(v => new GitLabVariable(v));
+  }
+
+  async createVariable(key: string, value: string, opts?: IVariableOptions): Promise<GitLabVariable> {
+    const raw = await this.client.requestCreateGroupVariable(this.id, key, value, opts);
+    return new GitLabVariable(raw);
+  }
+
+  async updateVariable(key: string, value: string, opts?: IVariableOptions): Promise<GitLabVariable> {
+    const raw = await this.client.requestUpdateGroupVariable(this.id, key, value, opts);
+    return new GitLabVariable(raw);
+  }
+
+  async deleteVariable(key: string): Promise<void> {
+    await this.client.requestDeleteGroupVariable(this.id, key);
+  }
+
+  // ---------------------------------------------------------------------------
+  // Mutation
+  // ---------------------------------------------------------------------------
+
+  /**
+   * Update group properties.
+   */
+  async update(data: {
+    name?: string;
+    path?: string;
+    description?: string;
+    visibility?: string;
+  }): Promise<void> {
+    await this.client.requestUpdateGroup(this.id, {
+      name: data.name,
+      path: data.path,
+      description: data.description,
+      visibility: data.visibility,
+    });
+  }
+
+  /**
+   * Upload an avatar image for this group (multipart FormData).
+   */
+  async setAvatar(imageData: Uint8Array, filename: string): Promise<void> {
+    await this.client.requestSetGroupAvatar(this.id, imageData, filename);
+  }
+
+  /**
+   * Remove the group's avatar.
+   */
+  async deleteAvatar(): Promise<void> {
+    await this.client.requestUpdateGroup(this.id, { avatar: '' });
+  }
+
+  /**
+   * Transfer this group to be a child of another group.
+   */
+  async transfer(parentGroupId: number): Promise<void> {
+    await this.client.requestTransferGroup(this.id, parentGroupId);
+  }
+
+  /**
+   * Delete this group.
+   */
+  async delete(): Promise<void> {
+    await this.client.requestDeleteGroup(this.id);
+  }
+
+  // ---------------------------------------------------------------------------
+  // Serialization
+  // ---------------------------------------------------------------------------
+
+  toJSON(): IGitLabGroup {
+    return {
+      id: this.id,
+      name: this.name,
+      full_path: this.fullPath,
+      description: this.description,
+      web_url: this.webUrl,
+      visibility: this.visibility,
+    };
+  }
+}

package/ts/gitlab.classes.job.ts

@@ -0,0 +1,104 @@
+import type { GitLabClient } from './gitlab.classes.gitlabclient.js';
+import type { IGitLabJob } from './gitlab.interfaces.js';
+
+export class GitLabJob {
+  // Raw data
+  public readonly id: number;
+  public readonly name: string;
+  public readonly stage: string;
+  public readonly status: string;
+  public readonly ref: string;
+  public readonly tag: boolean;
+  public readonly webUrl: string;
+  public readonly createdAt: string;
+  public readonly startedAt: string;
+  public readonly finishedAt: string;
+  public readonly duration: number;
+  public readonly queuedDuration: number;
+  public readonly coverage: number;
+  public readonly allowFailure: boolean;
+  public readonly failureReason: string;
+
+  /** @internal */
+  constructor(
+    private client: GitLabClient,
+    private projectId: number | string,
+    raw: IGitLabJob,
+  ) {
+    this.id = raw.id;
+    this.name = raw.name || '';
+    this.stage = raw.stage || '';
+    this.status = raw.status || '';
+    this.ref = raw.ref || '';
+    this.tag = raw.tag ?? false;
+    this.webUrl = raw.web_url || '';
+    this.createdAt = raw.created_at || '';
+    this.startedAt = raw.started_at || '';
+    this.finishedAt = raw.finished_at || '';
+    this.duration = raw.duration || 0;
+    this.queuedDuration = raw.queued_duration || 0;
+    this.coverage = raw.coverage || 0;
+    this.allowFailure = raw.allow_failure ?? false;
+    this.failureReason = raw.failure_reason || '';
+  }
+
+  // ---------------------------------------------------------------------------
+  // Log
+  // ---------------------------------------------------------------------------
+
+  async getLog(): Promise<string> {
+    return this.client.requestGetJobLog(this.projectId, this.id);
+  }
+
+  // ---------------------------------------------------------------------------
+  // Actions
+  // ---------------------------------------------------------------------------
+
+  async retry(): Promise<GitLabJob> {
+    const raw = await this.client.requestRetryJob(this.projectId, this.id);
+    return new GitLabJob(this.client, this.projectId, raw);
+  }
+
+  async cancel(): Promise<GitLabJob> {
+    const raw = await this.client.requestCancelJob(this.projectId, this.id);
+    return new GitLabJob(this.client, this.projectId, raw);
+  }
+
+  async play(): Promise<GitLabJob> {
+    const raw = await this.client.requestPlayJob(this.projectId, this.id);
+    return new GitLabJob(this.client, this.projectId, raw);
+  }
+
+  async erase(): Promise<void> {
+    await this.client.requestEraseJob(this.projectId, this.id);
+  }
+
+  // ---------------------------------------------------------------------------
+  // Serialization
+  // ---------------------------------------------------------------------------
+
+  toJSON(): IGitLabJob {
+    return {
+      id: this.id,
+      name: this.name,
+      stage: this.stage,
+      status: this.status,
+      ref: this.ref,
+      tag: this.tag,
+      web_url: this.webUrl,
+      created_at: this.createdAt,
+      started_at: this.startedAt,
+      finished_at: this.finishedAt,
+      duration: this.duration,
+      queued_duration: this.queuedDuration,
+      coverage: this.coverage,
+      allow_failure: this.allowFailure,
+      failure_reason: this.failureReason,
+      pipeline: { id: 0, project_id: 0, ref: '', sha: '', status: '' },
+      user: { id: 0, username: '', name: '', email: '', avatar_url: '', web_url: '', state: '' },
+      runner: { id: 0, description: '', active: false, is_shared: false },
+      artifacts: [],
+      artifacts_expire_at: '',
+    };
+  }
+}

package/ts/gitlab.classes.pipeline.ts

@@ -0,0 +1,122 @@
+import type { GitLabClient } from './gitlab.classes.gitlabclient.js';
+import type { IGitLabPipeline, IJobListOptions } from './gitlab.interfaces.js';
+import { GitLabJob } from './gitlab.classes.job.js';
+import { GitLabPipelineVariable } from './gitlab.classes.variable.js';
+import { GitLabTestReport } from './gitlab.classes.testreport.js';
+import { autoPaginate } from './gitlab.helpers.js';
+
+export class GitLabPipeline {
+  // Raw data
+  public readonly id: number;
+  public readonly iid: number;
+  public readonly projectId: number;
+  public readonly status: string;
+  public readonly ref: string;
+  public readonly sha: string;
+  public readonly webUrl: string;
+  public readonly duration: number;
+  public readonly queuedDuration: number;
+  public readonly createdAt: string;
+  public readonly updatedAt: string;
+  public readonly startedAt: string;
+  public readonly finishedAt: string;
+  public readonly source: string;
+  public readonly tag: boolean;
+
+  /** @internal */
+  constructor(
+    private client: GitLabClient,
+    raw: IGitLabPipeline,
+  ) {
+    this.id = raw.id;
+    this.iid = raw.iid || 0;
+    this.projectId = raw.project_id || 0;
+    this.status = raw.status || '';
+    this.ref = raw.ref || '';
+    this.sha = raw.sha || '';
+    this.webUrl = raw.web_url || '';
+    this.duration = raw.duration || 0;
+    this.queuedDuration = raw.queued_duration || 0;
+    this.createdAt = raw.created_at || '';
+    this.updatedAt = raw.updated_at || '';
+    this.startedAt = raw.started_at || '';
+    this.finishedAt = raw.finished_at || '';
+    this.source = raw.source || '';
+    this.tag = raw.tag ?? false;
+  }
+
+  // ---------------------------------------------------------------------------
+  // Jobs
+  // ---------------------------------------------------------------------------
+
+  async getJobs(opts?: IJobListOptions): Promise<GitLabJob[]> {
+    return autoPaginate(
+      (page, perPage) => this.client.requestGetPipelineJobs(this.projectId, this.id, { ...opts, page, perPage }),
+      opts,
+    ).then(jobs => jobs.map(j => new GitLabJob(this.client, this.projectId, j)));
+  }
+
+  // ---------------------------------------------------------------------------
+  // Variables & Test Report
+  // ---------------------------------------------------------------------------
+
+  async getVariables(): Promise<GitLabPipelineVariable[]> {
+    const vars = await this.client.requestGetPipelineVariables(this.projectId, this.id);
+    return vars.map(v => new GitLabPipelineVariable(v));
+  }
+
+  async getTestReport(): Promise<GitLabTestReport> {
+    const raw = await this.client.requestGetPipelineTestReport(this.projectId, this.id);
+    return new GitLabTestReport(raw);
+  }
+
+  // ---------------------------------------------------------------------------
+  // Actions
+  // ---------------------------------------------------------------------------
+
+  async retry(): Promise<GitLabPipeline> {
+    const raw = await this.client.requestRetryPipeline(this.projectId, this.id);
+    return new GitLabPipeline(this.client, raw);
+  }
+
+  async cancel(): Promise<GitLabPipeline> {
+    const raw = await this.client.requestCancelPipeline(this.projectId, this.id);
+    return new GitLabPipeline(this.client, raw);
+  }
+
+  async delete(): Promise<void> {
+    await this.client.requestDeletePipeline(this.projectId, this.id);
+  }
+
+  // ---------------------------------------------------------------------------
+  // Serialization
+  // ---------------------------------------------------------------------------
+
+  toJSON(): IGitLabPipeline {
+    return {
+      id: this.id,
+      iid: this.iid,
+      project_id: this.projectId,
+      status: this.status,
+      ref: this.ref,
+      sha: this.sha,
+      before_sha: '',
+      tag: this.tag,
+      web_url: this.webUrl,
+      duration: this.duration,
+      queued_duration: this.queuedDuration,
+      created_at: this.createdAt,
+      updated_at: this.updatedAt,
+      started_at: this.startedAt,
+      finished_at: this.finishedAt,
+      source: this.source,
+      coverage: '',
+      user: { id: 0, username: '', name: '', email: '', avatar_url: '', web_url: '', state: '' },
+      detailed_status: {
+        icon: '', text: '', label: '', group: '', tooltip: '',
+        has_details: false, details_path: '', favicon: '',
+      },
+      yaml_errors: '',
+    };
+  }
+}

package/ts/gitlab.classes.project.ts

@@ -0,0 +1,177 @@
+import type { GitLabClient } from './gitlab.classes.gitlabclient.js';
+import type { IGitLabProject, IListOptions, IVariableOptions, IPipelineListOptions } from './gitlab.interfaces.js';
+import { GitLabBranch } from './gitlab.classes.branch.js';
+import { GitLabTag } from './gitlab.classes.tag.js';
+import { GitLabProtectedBranch } from './gitlab.classes.protectedbranch.js';
+import { GitLabVariable } from './gitlab.classes.variable.js';
+import { GitLabPipeline } from './gitlab.classes.pipeline.js';
+import { autoPaginate } from './gitlab.helpers.js';
+
+export class GitLabProject {
+  // Raw data
+  public readonly id: number;
+  public readonly name: string;
+  public readonly fullPath: string;
+  public readonly description: string;
+  public readonly defaultBranch: string;
+  public readonly webUrl: string;
+  public readonly visibility: string;
+  public readonly topics: string[];
+  public readonly lastActivityAt: string;
+
+  /** @internal */
+  constructor(
+    private client: GitLabClient,
+    raw: IGitLabProject,
+  ) {
+    this.id = raw.id;
+    this.name = raw.name || '';
+    this.fullPath = raw.path_with_namespace || '';
+    this.description = raw.description || '';
+    this.defaultBranch = raw.default_branch || 'main';
+    this.webUrl = raw.web_url || '';
+    this.visibility = raw.visibility || 'private';
+    this.topics = raw.topics || [];
+    this.lastActivityAt = raw.last_activity_at || '';
+  }
+
+  // ---------------------------------------------------------------------------
+  // Branches & Tags
+  // ---------------------------------------------------------------------------
+
+  async getBranches(opts?: IListOptions): Promise<GitLabBranch[]> {
+    return autoPaginate(
+      (page, perPage) => this.client.requestGetRepoBranches(this.id, { ...opts, page, perPage }),
+      opts,
+    ).then(branches => branches.map(b => new GitLabBranch(b)));
+  }
+
+  async getTags(opts?: IListOptions): Promise<GitLabTag[]> {
+    return autoPaginate(
+      (page, perPage) => this.client.requestGetRepoTags(this.id, { ...opts, page, perPage }),
+      opts,
+    ).then(tags => tags.map(t => new GitLabTag(t)));
+  }
+
+  async getProtectedBranches(): Promise<GitLabProtectedBranch[]> {
+    const branches = await this.client.requestGetProtectedBranches(this.id);
+    return branches.map(b => new GitLabProtectedBranch(b));
+  }
+
+  async unprotectBranch(branchName: string): Promise<void> {
+    await this.client.requestUnprotectBranch(this.id, branchName);
+  }
+
+  // ---------------------------------------------------------------------------
+  // Variables (CI/CD)
+  // ---------------------------------------------------------------------------
+
+  async getVariables(): Promise<GitLabVariable[]> {
+    const vars = await this.client.requestGetProjectVariables(this.id);
+    return vars.map(v => new GitLabVariable(v));
+  }
+
+  async createVariable(key: string, value: string, opts?: IVariableOptions): Promise<GitLabVariable> {
+    const raw = await this.client.requestCreateProjectVariable(this.id, key, value, opts);
+    return new GitLabVariable(raw);
+  }
+
+  async updateVariable(key: string, value: string, opts?: IVariableOptions): Promise<GitLabVariable> {
+    const raw = await this.client.requestUpdateProjectVariable(this.id, key, value, opts);
+    return new GitLabVariable(raw);
+  }
+
+  async deleteVariable(key: string): Promise<void> {
+    await this.client.requestDeleteProjectVariable(this.id, key);
+  }
+
+  // ---------------------------------------------------------------------------
+  // Pipelines
+  // ---------------------------------------------------------------------------
+
+  async getPipelines(opts?: IPipelineListOptions): Promise<GitLabPipeline[]> {
+    return autoPaginate(
+      (page, perPage) => this.client.requestGetPipelines(this.id, { ...opts, page, perPage }),
+      opts,
+    ).then(pipelines => pipelines.map(p => new GitLabPipeline(this.client, p)));
+  }
+
+  async triggerPipeline(
+    ref: string,
+    variables?: { key: string; value: string; variable_type?: string }[],
+  ): Promise<GitLabPipeline> {
+    const raw = await this.client.requestTriggerPipeline(this.id, ref, variables);
+    return new GitLabPipeline(this.client, raw);
+  }
+
+  // ---------------------------------------------------------------------------
+  // Mutation
+  // ---------------------------------------------------------------------------
+
+  /**
+   * Update project properties.
+   */
+  async update(data: {
+    name?: string;
+    path?: string;
+    description?: string;
+    defaultBranch?: string;
+    visibility?: string;
+    topics?: string[];
+  }): Promise<void> {
+    await this.client.requestUpdateProject(this.id, {
+      name: data.name,
+      path: data.path,
+      description: data.description,
+      default_branch: data.defaultBranch,
+      visibility: data.visibility,
+      topics: data.topics,
+    });
+  }
+
+  /**
+   * Upload an avatar image for this project (multipart FormData).
+   */
+  async setAvatar(imageData: Uint8Array, filename: string): Promise<void> {
+    await this.client.requestSetProjectAvatar(this.id, imageData, filename);
+  }
+
+  /**
+   * Remove the project's avatar.
+   */
+  async deleteAvatar(): Promise<void> {
+    await this.client.requestUpdateProject(this.id, { avatar: '' });
+  }
+
+  /**
+   * Transfer this project to a different namespace.
+   */
+  async transfer(namespaceId: number): Promise<void> {
+    await this.client.requestTransferProject(this.id, namespaceId);
+  }
+
+  /**
+   * Delete this project.
+   */
+  async delete(): Promise<void> {
+    await this.client.requestDeleteProject(this.id);
+  }
+
+  // ---------------------------------------------------------------------------
+  // Serialization
+  // ---------------------------------------------------------------------------
+
+  toJSON(): IGitLabProject {
+    return {
+      id: this.id,
+      name: this.name,
+      path_with_namespace: this.fullPath,
+      description: this.description,
+      default_branch: this.defaultBranch,
+      web_url: this.webUrl,
+      visibility: this.visibility,
+      topics: this.topics,
+      last_activity_at: this.lastActivityAt,
+    };
+  }
+}

package/ts/gitlab.classes.protectedbranch.ts

@@ -0,0 +1,21 @@
+import type { IGitLabProtectedBranch } from './gitlab.interfaces.js';
+
+export class GitLabProtectedBranch {
+  public readonly id: number;
+  public readonly name: string;
+  public readonly allowForcePush: boolean;
+
+  constructor(raw: IGitLabProtectedBranch) {
+    this.id = raw.id;
+    this.name = raw.name || '';
+    this.allowForcePush = raw.allow_force_push ?? false;
+  }
+
+  toJSON(): IGitLabProtectedBranch {
+    return {
+      id: this.id,
+      name: this.name,
+      allow_force_push: this.allowForcePush,
+    };
+  }
+}

package/ts/gitlab.classes.tag.ts

@@ -0,0 +1,18 @@
+import type { IGitLabTag } from './gitlab.interfaces.js';
+
+export class GitLabTag {
+  public readonly name: string;
+  public readonly commitSha: string;
+
+  constructor(raw: IGitLabTag) {
+    this.name = raw.name || '';
+    this.commitSha = raw.commit?.id || '';
+  }
+
+  toJSON(): IGitLabTag {
+    return {
+      name: this.name,
+      commit: { id: this.commitSha },
+    };
+  }
+}

package/ts/gitlab.classes.testreport.ts

@@ -0,0 +1,97 @@
+import type { IGitLabTestReport, IGitLabTestSuite, IGitLabTestCase } from './gitlab.interfaces.js';
+
+export class GitLabTestCase {
+  public readonly status: string;
+  public readonly name: string;
+  public readonly classname: string;
+  public readonly executionTime: number;
+  public readonly systemOutput: string;
+  public readonly stackTrace: string;
+
+  constructor(raw: IGitLabTestCase) {
+    this.status = raw.status || '';
+    this.name = raw.name || '';
+    this.classname = raw.classname || '';
+    this.executionTime = raw.execution_time || 0;
+    this.systemOutput = raw.system_output || '';
+    this.stackTrace = raw.stack_trace || '';
+  }
+
+  toJSON(): IGitLabTestCase {
+    return {
+      status: this.status,
+      name: this.name,
+      classname: this.classname,
+      execution_time: this.executionTime,
+      system_output: this.systemOutput,
+      stack_trace: this.stackTrace,
+    };
+  }
+}
+
+export class GitLabTestSuite {
+  public readonly name: string;
+  public readonly totalTime: number;
+  public readonly totalCount: number;
+  public readonly successCount: number;
+  public readonly failedCount: number;
+  public readonly skippedCount: number;
+  public readonly errorCount: number;
+  public readonly testCases: GitLabTestCase[];
+
+  constructor(raw: IGitLabTestSuite) {
+    this.name = raw.name || '';
+    this.totalTime = raw.total_time || 0;
+    this.totalCount = raw.total_count || 0;
+    this.successCount = raw.success_count || 0;
+    this.failedCount = raw.failed_count || 0;
+    this.skippedCount = raw.skipped_count || 0;
+    this.errorCount = raw.error_count || 0;
+    this.testCases = (raw.test_cases || []).map(tc => new GitLabTestCase(tc));
+  }
+
+  toJSON(): IGitLabTestSuite {
+    return {
+      name: this.name,
+      total_time: this.totalTime,
+      total_count: this.totalCount,
+      success_count: this.successCount,
+      failed_count: this.failedCount,
+      skipped_count: this.skippedCount,
+      error_count: this.errorCount,
+      test_cases: this.testCases.map(tc => tc.toJSON()),
+    };
+  }
+}
+
+export class GitLabTestReport {
+  public readonly totalTime: number;
+  public readonly totalCount: number;
+  public readonly successCount: number;
+  public readonly failedCount: number;
+  public readonly skippedCount: number;
+  public readonly errorCount: number;
+  public readonly testSuites: GitLabTestSuite[];
+
+  constructor(raw: IGitLabTestReport) {
+    this.totalTime = raw.total_time || 0;
+    this.totalCount = raw.total_count || 0;
+    this.successCount = raw.success_count || 0;
+    this.failedCount = raw.failed_count || 0;
+    this.skippedCount = raw.skipped_count || 0;
+    this.errorCount = raw.error_count || 0;
+    this.testSuites = (raw.test_suites || []).map(ts => new GitLabTestSuite(ts));
+  }
+
+  toJSON(): IGitLabTestReport {
+    return {
+      total_time: this.totalTime,
+      total_count: this.totalCount,
+      success_count: this.successCount,
+      failed_count: this.failedCount,
+      skipped_count: this.skippedCount,
+      error_count: this.errorCount,
+      test_suites: this.testSuites.map(ts => ts.toJSON()),
+    };
+  }
+}