@ci-kit/gitlab 0.0.0-stage → 0.0.1

package/dist/index.d.mts

@@ -0,0 +1,59 @@
+interface GitlabClientOptions {
+    baseUrl: string;
+    projectId: string | number;
+    token: string;
+    tokenType?: 'job' | 'private';
+}
+interface ReleaseAsset {
+    name: string;
+    url: string;
+    link_type?: 'other' | 'package' | 'image';
+}
+interface ReleaseInput {
+    tagName: string;
+    name: string;
+    description: string;
+    assets?: ReleaseAsset[];
+    ref?: string;
+}
+interface PackageUpload {
+    packageName: string;
+    version: string;
+    filePath: string;
+    fileName?: string;
+}
+interface ScheduleInput {
+    description: string;
+    ref: string;
+    cron: string;
+    cronTimezone?: string;
+}
+declare class GitlabClient {
+    private readonly options;
+    private readonly apiBase;
+    private readonly headers;
+    constructor(options: GitlabClientOptions);
+    get<T>(path: string, query?: Record<string, string | number>): Promise<T>;
+    paginate<T>(path: string, query?: Record<string, string | number>): Promise<T[]>;
+    post<T>(path: string, body: unknown): Promise<T>;
+    put<T>(path: string, body: unknown): Promise<T>;
+    delete(path: string): Promise<void>;
+    getRelease(tagName: string): Promise<Record<string, unknown> | null>;
+    createRelease(input: ReleaseInput): Promise<void>;
+    uploadPackage({ packageName, version, filePath, fileName }: PackageUpload): Promise<void>;
+    listPackages(packageName?: string): Promise<Array<{
+        id: number;
+        name: string;
+        version: string;
+    }>>;
+    deletePackage(id: number): Promise<void>;
+    upsertSchedule(input: ScheduleInput): Promise<{
+        id: number;
+        action: 'created' | 'updated' | 'unchanged';
+    }>;
+    private url;
+}
+declare function clientFromEnv(env?: NodeJS.ProcessEnv): GitlabClient;
+
+export { GitlabClient, clientFromEnv };
+export type { GitlabClientOptions, PackageUpload, ReleaseAsset, ReleaseInput, ScheduleInput };

package/dist/index.d.ts

@@ -0,0 +1,59 @@
+interface GitlabClientOptions {
+    baseUrl: string;
+    projectId: string | number;
+    token: string;
+    tokenType?: 'job' | 'private';
+}
+interface ReleaseAsset {
+    name: string;
+    url: string;
+    link_type?: 'other' | 'package' | 'image';
+}
+interface ReleaseInput {
+    tagName: string;
+    name: string;
+    description: string;
+    assets?: ReleaseAsset[];
+    ref?: string;
+}
+interface PackageUpload {
+    packageName: string;
+    version: string;
+    filePath: string;
+    fileName?: string;
+}
+interface ScheduleInput {
+    description: string;
+    ref: string;
+    cron: string;
+    cronTimezone?: string;
+}
+declare class GitlabClient {
+    private readonly options;
+    private readonly apiBase;
+    private readonly headers;
+    constructor(options: GitlabClientOptions);
+    get<T>(path: string, query?: Record<string, string | number>): Promise<T>;
+    paginate<T>(path: string, query?: Record<string, string | number>): Promise<T[]>;
+    post<T>(path: string, body: unknown): Promise<T>;
+    put<T>(path: string, body: unknown): Promise<T>;
+    delete(path: string): Promise<void>;
+    getRelease(tagName: string): Promise<Record<string, unknown> | null>;
+    createRelease(input: ReleaseInput): Promise<void>;
+    uploadPackage({ packageName, version, filePath, fileName }: PackageUpload): Promise<void>;
+    listPackages(packageName?: string): Promise<Array<{
+        id: number;
+        name: string;
+        version: string;
+    }>>;
+    deletePackage(id: number): Promise<void>;
+    upsertSchedule(input: ScheduleInput): Promise<{
+        id: number;
+        action: 'created' | 'updated' | 'unchanged';
+    }>;
+    private url;
+}
+declare function clientFromEnv(env?: NodeJS.ProcessEnv): GitlabClient;
+
+export { GitlabClient, clientFromEnv };
+export type { GitlabClientOptions, PackageUpload, ReleaseAsset, ReleaseInput, ScheduleInput };

package/dist/index.mjs

@@ -0,0 +1,120 @@
+import { readFileSync } from 'node:fs';
+import process from 'node:process';
+import { requestJson, request } from '@ci-kit/http';
+
+class GitlabClient {
+  constructor(options) {
+    this.options = options;
+    this.apiBase = `${options.baseUrl.replace(/\/$/, "")}/api/v4/projects/${encodeURIComponent(String(options.projectId))}`;
+    this.headers = options.tokenType === "private" ? { "PRIVATE-TOKEN": options.token } : { "JOB-TOKEN": options.token };
+  }
+  apiBase;
+  headers;
+  async get(path, query = {}) {
+    return requestJson(this.url(path, query), { headers: this.headers });
+  }
+  async paginate(path, query = {}) {
+    const rows = [];
+    let page = 1;
+    while (true) {
+      const url = this.url(path, { ...query, per_page: 100, page });
+      const response = await request(url, { headers: this.headers });
+      rows.push(...await response.json());
+      const next = response.headers.get("x-next-page");
+      if (!next) {
+        break;
+      }
+      page = Number(next);
+    }
+    return rows;
+  }
+  async post(path, body) {
+    return requestJson(this.url(path), {
+      method: "POST",
+      headers: { ...this.headers, "content-type": "application/json" },
+      body: JSON.stringify(body)
+    });
+  }
+  async put(path, body) {
+    return requestJson(this.url(path), {
+      method: "PUT",
+      headers: { ...this.headers, "content-type": "application/json" },
+      body: JSON.stringify(body)
+    });
+  }
+  async delete(path) {
+    await request(this.url(path), { method: "DELETE", headers: this.headers });
+  }
+  async getRelease(tagName) {
+    try {
+      return await this.get(`releases/${encodeURIComponent(tagName)}`);
+    } catch (error) {
+      if (error instanceof Error && error.name === "HttpError") {
+        return null;
+      }
+      throw error;
+    }
+  }
+  async createRelease(input) {
+    await this.post("releases", {
+      tag_name: input.tagName,
+      ref: input.ref,
+      name: input.name,
+      description: input.description,
+      assets: input.assets ? { links: input.assets } : void 0
+    });
+  }
+  async uploadPackage({ packageName, version, filePath, fileName }) {
+    const name = fileName ?? filePath.split(/[\\/]/).pop();
+    const body = readFileSync(filePath);
+    await request(this.url(`packages/generic/${encodeURIComponent(packageName)}/${encodeURIComponent(version)}/${encodeURIComponent(name)}`), {
+      method: "PUT",
+      headers: { ...this.headers, "content-type": "application/octet-stream" },
+      body
+    });
+  }
+  async listPackages(packageName) {
+    const query = packageName ? { package_name: packageName } : {};
+    return this.paginate("packages", query);
+  }
+  async deletePackage(id) {
+    await this.delete(`packages/${id}`);
+  }
+  async upsertSchedule(input) {
+    const existing = await this.paginate("pipeline_schedules");
+    const match = existing.find((item) => item.description === input.description);
+    const body = {
+      description: input.description,
+      ref: input.ref,
+      cron: input.cron,
+      cron_timezone: input.cronTimezone ?? "Asia/Shanghai"
+    };
+    if (!match) {
+      const created = await this.post("pipeline_schedules", body);
+      return { id: created.id, action: "created" };
+    }
+    if (match.cron === input.cron && match.ref === input.ref) {
+      return { id: match.id, action: "unchanged" };
+    }
+    await this.put(`pipeline_schedules/${match.id}`, body);
+    return { id: match.id, action: "updated" };
+  }
+  url(path, query = {}) {
+    const url = new URL(`${this.apiBase}/${path.replace(/^\//, "")}`);
+    for (const [key, value] of Object.entries(query)) {
+      url.searchParams.set(key, String(value));
+    }
+    return url.toString();
+  }
+}
+function clientFromEnv(env = process.env) {
+  const baseUrl = env.CI_SERVER_URL;
+  const projectId = env.CI_PROJECT_ID;
+  const token = env.CI_JOB_TOKEN;
+  if (!baseUrl || !projectId || !token) {
+    throw new Error("CI_SERVER_URL, CI_PROJECT_ID and CI_JOB_TOKEN are required");
+  }
+  return new GitlabClient({ baseUrl, projectId, token });
+}
+
+export { GitlabClient, clientFromEnv };

package/package.json

@@ -1,6 +1,39 @@
 {
   "name": "@ci-kit/gitlab",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "type": "module",
+  "version": "0.0.1",
+  "description": "Minimal GitLab API client for releases, packages and schedules",
+  "author": "imba97",
+  "license": "MIT",
+  "homepage": "https://github.com/cikit-js/ci-kit#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/cikit-js/ci-kit.git"
+  },
+  "bugs": {
+    "url": "https://github.com/cikit-js/ci-kit/issues"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.mts",
+      "import": "./dist/index.mjs"
+    }
+  },
+  "main": "./dist/index.mjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.mts",
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@ci-kit/http": "0.0.1"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "unbuild",
+    "typecheck": "tsc --noEmit",
+    "stub": "unbuild --stub"
+  }
 }

package/README.md

@@ -1,3 +0,0 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.