@apiclient.xyz/gitlab 2.4.0 → 2.6.0

package/ts/gitlab.classes.variable.ts

@@ -0,0 +1,50 @@
+import type { IGitLabVariable, IGitLabPipelineVariable } from './gitlab.interfaces.js';
+
+export class GitLabVariable {
+  public readonly key: string;
+  public readonly value: string;
+  public readonly variableType: string;
+  public readonly protected: boolean;
+  public readonly masked: boolean;
+  public readonly environmentScope: string;
+
+  constructor(raw: IGitLabVariable) {
+    this.key = raw.key || '';
+    this.value = raw.value || '';
+    this.variableType = raw.variable_type || 'env_var';
+    this.protected = raw.protected ?? false;
+    this.masked = raw.masked ?? false;
+    this.environmentScope = raw.environment_scope || '*';
+  }
+
+  toJSON(): IGitLabVariable {
+    return {
+      key: this.key,
+      value: this.value,
+      variable_type: this.variableType,
+      protected: this.protected,
+      masked: this.masked,
+      environment_scope: this.environmentScope,
+    };
+  }
+}
+
+export class GitLabPipelineVariable {
+  public readonly key: string;
+  public readonly value: string;
+  public readonly variableType: string;
+
+  constructor(raw: IGitLabPipelineVariable) {
+    this.key = raw.key || '';
+    this.value = raw.value || '';
+    this.variableType = raw.variable_type || 'env_var';
+  }
+
+  toJSON(): IGitLabPipelineVariable {
+    return {
+      key: this.key,
+      value: this.value,
+      variable_type: this.variableType,
+    };
+  }
+}

package/ts/gitlab.helpers.ts

@@ -0,0 +1,26 @@
+/**
+ * Auto-paginate a list endpoint.
+ * If opts includes a specific page, returns just that page (no auto-pagination).
+ */
+export async function autoPaginate<T>(
+  fetchPage: (page: number, perPage: number) => Promise<T[]>,
+  opts?: { page?: number; perPage?: number },
+): Promise<T[]> {
+  const perPage = opts?.perPage || 50;
+
+  // If caller requests a specific page, return just that page
+  if (opts?.page) {
+    return fetchPage(opts.page, perPage);
+  }
+
+  // Otherwise auto-paginate through all pages
+  const all: T[] = [];
+  let page = 1;
+  while (true) {
+    const items = await fetchPage(page, perPage);
+    all.push(...items);
+    if (items.length < perPage) break;
+    page++;
+  }
+  return all;
+}

package/ts/gitlab.interfaces.ts

@@ -1,3 +1,52 @@
+// ---------------------------------------------------------------------------
+// Common
+// ---------------------------------------------------------------------------
+
+export interface ITestConnectionResult {
+  ok: boolean;
+  error?: string;
+}
+
+export interface IListOptions {
+  search?: string;
+  page?: number;
+  perPage?: number;
+}
+
+// ---------------------------------------------------------------------------
+// Pipeline / Job list options
+// ---------------------------------------------------------------------------
+
+export interface IPipelineListOptions extends IListOptions {
+  /** Filter by pipeline status */
+  status?: string;
+  /** Filter by branch or tag ref */
+  ref?: string;
+  /** Filter by trigger source (push, web, trigger, schedule, api, external, pipeline, chat, merge_request_event, …) */
+  source?: string;
+  /** Filter by scope (running, pending, finished, branches, tags) */
+  scope?: string;
+  /** Filter by the user who triggered the pipeline */
+  username?: string;
+  /** Return pipelines updated after this ISO 8601 date */
+  updatedAfter?: string;
+  /** Return pipelines updated before this ISO 8601 date */
+  updatedBefore?: string;
+  /** Order by field (id, status, ref, updated_at, user_id). Default: id */
+  orderBy?: string;
+  /** Sort direction (asc, desc). Default: desc */
+  sort?: string;
+}
+
+export interface IJobListOptions extends IListOptions {
+  /** Filter by job scope(s) */
+  scope?: string[];
+}
+
+// ---------------------------------------------------------------------------
+// Users
+// ---------------------------------------------------------------------------
+
 export interface IGitLabUser {
   id: number;
   username: string;
@@ -8,6 +57,10 @@ export interface IGitLabUser {
   state: string;
 }
 
+// ---------------------------------------------------------------------------
+// Projects
+// ---------------------------------------------------------------------------
+
 export interface IGitLabProject {
   id: number;
   name: string;
@@ -20,6 +73,10 @@ export interface IGitLabProject {
   last_activity_at: string;
 }
 
+// ---------------------------------------------------------------------------
+// Groups
+// ---------------------------------------------------------------------------
+
 export interface IGitLabGroup {
   id: number;
   name: string;
@@ -29,6 +86,10 @@ export interface IGitLabGroup {
   visibility: string;
 }
 
+// ---------------------------------------------------------------------------
+// Variables
+// ---------------------------------------------------------------------------
+
 export interface IGitLabVariable {
   key: string;
   value: string;
@@ -44,32 +105,133 @@ export interface IVariableOptions {
   environment_scope?: string;
 }
 
+// ---------------------------------------------------------------------------
+// Protected Branches
+// ---------------------------------------------------------------------------
+
 export interface IGitLabProtectedBranch {
   id: number;
   name: string;
   allow_force_push: boolean;
 }
 
+// ---------------------------------------------------------------------------
+// Pipelines
+// ---------------------------------------------------------------------------
+
 export interface IGitLabPipeline {
   id: number;
+  iid: number;
   project_id: number;
   status: string;
   ref: string;
   sha: string;
+  before_sha: string;
+  tag: boolean;
   web_url: string;
   duration: number;
+  queued_duration: number;
   created_at: string;
+  updated_at: string;
+  started_at: string;
+  finished_at: string;
   source: string;
+  coverage: string;
+  user: IGitLabUser;
+  detailed_status: {
+    icon: string;
+    text: string;
+    label: string;
+    group: string;
+    tooltip: string;
+    has_details: boolean;
+    details_path: string;
+    favicon: string;
+  };
+  yaml_errors: string;
+}
+
+export interface IGitLabPipelineVariable {
+  key: string;
+  value: string;
+  variable_type: string;
+}
+
+export interface IGitLabTestReport {
+  total_time: number;
+  total_count: number;
+  success_count: number;
+  failed_count: number;
+  skipped_count: number;
+  error_count: number;
+  test_suites: IGitLabTestSuite[];
+}
+
+export interface IGitLabTestSuite {
+  name: string;
+  total_time: number;
+  total_count: number;
+  success_count: number;
+  failed_count: number;
+  skipped_count: number;
+  error_count: number;
+  test_cases: IGitLabTestCase[];
+}
+
+export interface IGitLabTestCase {
+  status: string;
+  name: string;
+  classname: string;
+  execution_time: number;
+  system_output: string;
+  stack_trace: string;
 }
 
+// ---------------------------------------------------------------------------
+// Jobs
+// ---------------------------------------------------------------------------
+
 export interface IGitLabJob {
   id: number;
   name: string;
   stage: string;
   status: string;
+  ref: string;
+  tag: boolean;
+  web_url: string;
+  created_at: string;
+  started_at: string;
+  finished_at: string;
   duration: number;
+  queued_duration: number;
+  coverage: number;
+  allow_failure: boolean;
+  failure_reason: string;
+  pipeline: {
+    id: number;
+    project_id: number;
+    ref: string;
+    sha: string;
+    status: string;
+  };
+  user: IGitLabUser;
+  runner: {
+    id: number;
+    description: string;
+    active: boolean;
+    is_shared: boolean;
+  };
+  artifacts: {
+    filename: string;
+    size: number;
+  }[];
+  artifacts_expire_at: string;
 }
 
+// ---------------------------------------------------------------------------
+// Branches & Tags
+// ---------------------------------------------------------------------------
+
 export interface IGitLabBranch {
   name: string;
   commit: {
@@ -83,14 +245,3 @@ export interface IGitLabTag {
     id: string;
   };
 }
-
-export interface ITestConnectionResult {
-  ok: boolean;
-  error?: string;
-}
-
-export interface IListOptions {
-  search?: string;
-  page?: number;
-  perPage?: number;
-}

package/ts/index.ts

@@ -1,4 +1,21 @@
+// Main client
 export { GitLabClient } from './gitlab.classes.gitlabclient.js';
+
+// Domain classes
+export { GitLabGroup } from './gitlab.classes.group.js';
+export { GitLabProject } from './gitlab.classes.project.js';
+export { GitLabPipeline } from './gitlab.classes.pipeline.js';
+export { GitLabJob } from './gitlab.classes.job.js';
+export { GitLabBranch } from './gitlab.classes.branch.js';
+export { GitLabTag } from './gitlab.classes.tag.js';
+export { GitLabProtectedBranch } from './gitlab.classes.protectedbranch.js';
+export { GitLabVariable, GitLabPipelineVariable } from './gitlab.classes.variable.js';
+export { GitLabTestReport, GitLabTestSuite, GitLabTestCase } from './gitlab.classes.testreport.js';
+
+// Helpers
+export { autoPaginate } from './gitlab.helpers.js';
+
+// Interfaces (raw API types)
 export type {
   IGitLabUser,
   IGitLabProject,
@@ -9,8 +26,16 @@ export type {
   IGitLabTag,
   IVariableOptions,
   IGitLabPipeline,
+  IGitLabPipelineVariable,
+  IGitLabTestReport,
+  IGitLabTestSuite,
+  IGitLabTestCase,
   IGitLabJob,
   ITestConnectionResult,
   IListOptions,
+  IPipelineListOptions,
+  IJobListOptions,
 } from './gitlab.interfaces.js';
+
+// Commit info
 export { commitinfo } from './00_commitinfo_data.js';