@hestia-earth/pipeline-utils 0.10.2 → 0.11.0

package/CHANGELOG.md

@@ -2,6 +2,26 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [0.11.0](https://gitlab.com/hestia-earth/hestia-pipeline-utils/compare/v0.10.4...v0.11.0) (2023-06-16)
+
+
+### ⚠ BREAKING CHANGES
+
+* **gitlab:** `readFile` in gitlab has been renamed `readFileRaw`
+
+### Features
+
+* **gitlab:** add function to retrun file content ([cec9f1e](https://gitlab.com/hestia-earth/hestia-pipeline-utils/commit/cec9f1e818994925837ade5e3cfc4498e724212f))
+
+### [0.10.4](https://gitlab.com/hestia-earth/hestia-pipeline-utils/compare/v0.10.3...v0.10.4) (2023-06-15)
+
+### [0.10.3](https://gitlab.com/hestia-earth/hestia-pipeline-utils/compare/v0.10.2...v0.10.3) (2023-06-15)
+
+
+### Features
+
+* **gitlab:** add `listFiles` and `readFile` functions ([76b4daa](https://gitlab.com/hestia-earth/hestia-pipeline-utils/commit/76b4daa2eeb23d15b5a09637756fc0c7c3200aed))
+
 ### [0.10.2](https://gitlab.com/hestia-earth/hestia-pipeline-utils/compare/v0.10.1...v0.10.2) (2023-06-13)
 
 

package/dist/gitlab.d.ts

@@ -0,0 +1,14 @@
+/// <reference types="node" />
+import { Readable } from 'stream';
+export interface IGitlabTreeFile {
+    id?: string;
+    name: string;
+    path: string;
+}
+export interface IGitlabFile {
+    size: number;
+    content: string;
+}
+export declare const listFiles: (path: string, page?: number, limit?: number) => Promise<IGitlabTreeFile[]>;
+export declare const readFile: ({ path }: Partial<IGitlabTreeFile>) => Promise<IGitlabFile>;
+export declare const readFileRaw: ({ id }: Partial<IGitlabTreeFile>) => Promise<Readable>;

package/dist/gitlab.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.readFileRaw = exports.readFile = exports.listFiles = void 0;
+const axios_1 = require("axios");
+const token = process.env.GITLAB_TOKEN;
+const projectId = process.env.GITLAB_PROJECT_ID;
+const branch = process.env.GITLAB_BRANCH;
+const gitlabUrl = `https://gitlab.com/api/v4/projects/${projectId}`;
+const headers = { 'PRIVATE-TOKEN': token };
+const listFiles = async (path, page = 1, limit = 100) => {
+    const { data } = await axios_1.default.get(`${gitlabUrl}/repository/tree`, {
+        headers,
+        params: { page, per_page: limit, ref: branch, path }
+    });
+    return [
+        ...data,
+        ...(data.length === limit ? await (0, exports.listFiles)(path, page + 1) : [])
+    ];
+};
+exports.listFiles = listFiles;
+const readFile = async ({ path }) => {
+    const { data } = await axios_1.default.get(`${gitlabUrl}/repository/files/${encodeURIComponent(path)}`, {
+        headers,
+        params: { ref: branch }
+    });
+    return data;
+};
+exports.readFile = readFile;
+const readFileRaw = async ({ id }) => {
+    const { data } = await axios_1.default.get(`${gitlabUrl}/repository/blobs/${id}/raw`, {
+        headers,
+        responseType: 'stream'
+    });
+    return data;
+};
+exports.readFileRaw = readFileRaw;
+//# sourceMappingURL=gitlab.js.map

package/dist/gitlab.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"gitlab.js","sourceRoot":"","sources":["../src/gitlab.ts"],"names":[],"mappings":";;;AACA,iCAA0B;AAa1B,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC;AACvC,MAAM,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC;AAChD,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC;AAEzC,MAAM,SAAS,GAAG,sCAAsC,SAAS,EAAE,CAAC;AACpE,MAAM,OAAO,GAAG,EAAE,eAAe,EAAE,KAAK,EAAE,CAAC;AAEpC,MAAM,SAAS,GAAG,KAAK,EAAE,IAAY,EAAE,IAAI,GAAG,CAAC,EAAE,KAAK,GAAG,GAAG,EAA8B,EAAE;IACjG,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,eAAK,CAAC,GAAG,CAAoB,GAAG,SAAS,kBAAkB,EAAE;QAClF,OAAO;QACP,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE;KACrD,CAAC,CAAC;IACH,OAAO;QACL,GAAG,IAAI;QACP,GAAG,CAAC,IAAI,CAAC,MAAM,KAAK,KAAK,CAAC,CAAC,CAAC,MAAM,IAAA,iBAAS,EAAC,IAAI,EAAE,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;KAClE,CAAC;AACJ,CAAC,CAAC;AATW,QAAA,SAAS,aASpB;AAEK,MAAM,QAAQ,GAAG,KAAK,EAAE,EAAE,IAAI,EAA4B,EAAE,EAAE;IACnE,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,eAAK,CAAC,GAAG,CAAc,GAAG,SAAS,qBAAqB,kBAAkB,CAAC,IAAI,CAAC,EAAE,EAAE;QACzG,OAAO;QACP,MAAM,EAAE,EAAE,GAAG,EAAE,MAAM,EAAE;KACxB,CAAC,CAAC;IACH,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AANW,QAAA,QAAQ,YAMnB;AAEK,MAAM,WAAW,GAAG,KAAK,EAAE,EAAE,EAAE,EAA4B,EAAE,EAAE;IACpE,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,eAAK,CAAC,GAAG,CAAW,GAAG,SAAS,qBAAqB,EAAE,MAAM,EAAE;QACpF,OAAO;QACP,YAAY,EAAE,QAAQ;KACvB,CAAC,CAAC;IACH,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AANW,QAAA,WAAW,eAMtB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hestia-earth/pipeline-utils",
-  "version": "0.10.2",
+  "version": "0.11.0",
   "description": "Utilities for running pipelines",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -41,7 +41,8 @@
     "@hestia-earth/api": ">=0.19.0",
     "@hestia-earth/json-schema": ">=20.0.0",
     "@hestia-earth/schema": ">=20.0.0",
-    "@hestia-earth/utils": ">=0.11.2"
+    "@hestia-earth/utils": ">=0.11.2",
+    "axios": "^1.0.0"
   },
   "devDependencies": {
     "@commitlint/cli": "^17.4.2",
@@ -63,6 +64,7 @@
     "@types/sinon": "^9.0.11",
     "@typescript-eslint/eslint-plugin": "^5.27.1",
     "@typescript-eslint/parser": "^5.27.1",
+    "axios": "^1.4.0",
     "chai": "^4.3.7",
     "eslint": "^7.32.0",
     "eslint-plugin-jsdoc": "^30.7.13",

package/src/gitlab.ts

@@ -0,0 +1,47 @@
+import { Readable } from 'stream';
+import axios from 'axios';
+
+export interface IGitlabTreeFile {
+  id?: string;
+  name: string;
+  path: string;
+}
+
+export interface IGitlabFile {
+  size: number;
+  content: string;
+}
+
+const token = process.env.GITLAB_TOKEN;
+const projectId = process.env.GITLAB_PROJECT_ID;
+const branch = process.env.GITLAB_BRANCH;
+
+const gitlabUrl = `https://gitlab.com/api/v4/projects/${projectId}`;
+const headers = { 'PRIVATE-TOKEN': token };
+
+export const listFiles = async (path: string, page = 1, limit = 100): Promise<IGitlabTreeFile[]> => {
+  const { data } = await axios.get<IGitlabTreeFile[]>(`${gitlabUrl}/repository/tree`, {
+    headers,
+    params: { page, per_page: limit, ref: branch, path }
+  });
+  return [
+    ...data,
+    ...(data.length === limit ? await listFiles(path, page + 1) : [])
+  ];
+};
+
+export const readFile = async ({ path }: Partial<IGitlabTreeFile>) => {
+  const { data } = await axios.get<IGitlabFile>(`${gitlabUrl}/repository/files/${encodeURIComponent(path)}`, {
+    headers,
+    params: { ref: branch }
+  });
+  return data;
+};
+
+export const readFileRaw = async ({ id }: Partial<IGitlabTreeFile>) => {
+  const { data } = await axios.get<Readable>(`${gitlabUrl}/repository/blobs/${id}/raw`, {
+    headers,
+    responseType: 'stream'
+  });
+  return data;
+};