@pittica/google-cloud-storage-helpers 1.4.0 → 1.6.0

package/dist/index.js

@@ -19,7 +19,8 @@ const {
   getFiles,
   listFiles,
   listFolders,
-  copiedFile
+  copiedFile,
+  readFile
 } = require("./storage/file");
 const {
   downloadBucket,
@@ -30,6 +31,9 @@ const {
   writeJson,
   groupJson
 } = require("./storage/json");
+const {
+  txtContentToArray
+} = require("./storage/txt");
 const {
   getStorage,
   getBucket
@@ -41,10 +45,12 @@ exports.getFiles = getFiles;
 exports.listFiles = listFiles;
 exports.listFolders = listFolders;
 exports.copiedFile = copiedFile;
+exports.readFile = readFile;
 exports.writeJson = writeJson;
 exports.groupJson = groupJson;
 exports.downloadFile = downloadFile;
 exports.downloadBucket = downloadBucket;
 exports.downloadFolder = downloadFolder;
 exports.getStorage = getStorage;
-exports.getBucket = getBucket;
+exports.getBucket = getBucket;
+exports.txtContentToArray = txtContentToArray;

package/dist/scripts.js

@@ -21,5 +21,6 @@ const {
  *
  * @param {string} name Bucket name.
  * @param {string} destination Destination path.
+ * @param {string} projectId Optional project ID.
  */
-exports.download = async (name, destination = __dirname) => downloadBucket(name, destination);
+exports.download = async (name, destination = __dirname, projectId = null) => downloadBucket(name, destination, projectId);

package/dist/storage/download.js

@@ -14,7 +14,6 @@
 
 const path = require("path");
 const {
-  Storage,
   TransferManager
 } = require("@google-cloud/storage");
 const log = require("@pittica/logger-helpers");
@@ -25,9 +24,10 @@ const fs = require("fs");
  *
  * @param {string} bucket Bucket name.
  * @param {string} destination Destination path.
+ * @param {string} projectId Optional project ID.
  */
-exports.downloadBucket = async (bucket, destination = __dirname) => {
-  const storage = new Storage();
+exports.downloadBucket = async (bucket, destination = __dirname, projectId = null) => {
+  const storage = getStorage(projectId);
   const source = storage.bucket(bucket);
   const [files] = await source.getFiles();
   files.forEach(({
@@ -59,10 +59,11 @@ exports.downloadFile = async (file, bucket, directory = __dirname) => {
  * @param {string} folder Folder name.
  * @param {Bucket} bucket Google Cloud Storage bucket object.
  * @param {string} directory Destination directory.
+ * @param {string} projectId Optional project ID.
  * @returns {Promise} Response.
  */
-exports.downloadFolder = (folder, bucket, directory = __dirname) => {
-  const storage = new Storage();
+exports.downloadFolder = (folder, bucket, directory = __dirname, projectId = null) => {
+  const storage = getStorage(projectId);
   const manager = new TransferManager(storage.bucket(bucket));
   const destination = path.join(directory, folder);
   if (!fs.existsSync(destination)) {

package/dist/storage/file.js

@@ -12,12 +12,10 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-const {
-  Storage
-} = require("@google-cloud/storage");
 const log = require("@pittica/logger-helpers");
 const {
-  getStorage
+  getStorage,
+  getBucket
 } = require("./storage");
 
 /**
@@ -25,9 +23,10 @@ const {
  *
  * @param {string} source Source bucket.
  * @param {string} destination Destination bucket.
+ * @param {string} projectId Optional project ID.
  */
-exports.moveFiles = async (source, destination) => {
-  const storage = getStorage();
+exports.moveFiles = async (source, destination, projectId = null) => {
+  const storage = getStorage(projectId);
   const bucket = storage.bucket(destination);
   const [files] = await storage.bucket(source).getFiles();
   files.forEach(results => Array.isArray(results) ? results.forEach(file => exports.moveFile(file, bucket)) : exports.moveFile(results, bucket));
@@ -87,10 +86,11 @@ exports.getFiles = (storage, source, prefix) => storage.bucket(source).getFiles(
  *
  * @param {string} bucket Bucket name.
  * @param {string} prefix Files prefix.
+ * @param {string} projectId Optional project ID.
  * @returns {Array} Files from the given bucket.
  * @since 1.3.0
  */
-exports.listFiles = (source, prefix) => getStorage().bucket(source).getFiles({
+exports.listFiles = (source, prefix, projectId = null) => getStorage(projectId).bucket(source).getFiles({
   prefix,
   autoPaginate: false,
   fields: "items(name)"
@@ -106,10 +106,11 @@ exports.listFiles = (source, prefix) => getStorage().bucket(source).getFiles({
  *
  * @param {string} bucket Bucket name.
  * @param {string} prefix Files prefix.
+ * @param {string} projectId Optional project ID.
  * @returns {Array} Folders from the given bucket.
  * @since 1.3.0
  */
-exports.listFolders = async (source, prefix = "") => await getStorage().bucket(source).getFiles({
+exports.listFolders = async (source, prefix = "", projectId = null) => await getStorage(projectId).bucket(source).getFiles({
   prefix,
   autoPaginate: false,
   delimiter: "/",
@@ -132,4 +133,18 @@ exports.copiedFile = response => {
     return response[0];
   }
   return null;
+};
+
+/**
+ * Downloads a file from Google Cloud Storage.
+ *
+ * @param {string} file File name and path.
+ * @param {string} bucket Bucket name.
+ * @param {string} projectId Optional project ID.
+ * @returns {Buffer} File content.
+ * @since 1.5.0
+ */
+exports.readFile = async (file, bucket, projectId = null) => {
+  const [contents] = await getBucket(bucket, projectId).file(file).download();
+  return Buffer.from(contents);
 };

package/dist/storage/json.js

@@ -13,35 +13,46 @@
 // limitations under the License.
 
 const {
-  Storage
-} = require("@google-cloud/storage");
+  finished
+} = require("stream/promises");
 const log = require("@pittica/logger-helpers");
+const {
+  getStorage
+} = require("./storage");
 
 /**
  * Writes JSON data.
  *
  * @param {string} file File name and path.
  * @param {object} body Document body.
- *
- * @returns {boolean} Write action response.
+ * @param {string} bucket Bucket name.
+ * @param {string} projectId Optional project ID.
+ * @returns {boolean} A value indicating whether the operation was successful.
  */
-exports.writeJson = async (file, body, bucket) => {
-  const storage = new Storage();
+exports.writeJson = async (file, body, bucket, projectId = null) => {
+  const buffer = Buffer.from(JSON.stringify(body));
+  const storage = getStorage(projectId);
   const stream = storage.bucket(bucket).file(file).createWriteStream({
     metadata: {
       contentType: "application/json"
     }
   });
-  stream.on("error", error => log.error(error));
-  stream.on("finish", () => log.success(`"${file}" has been written.`));
-  const buffer = Buffer.from(JSON.stringify(body));
-  return stream.end(buffer);
+  try {
+    stream.end(buffer);
+    await finished(stream);
+    log.success(`"${file}" has been written.`);
+    return true;
+  } catch (error) {
+    log.error(error);
+    return false;
+  }
 };
 
 /**
  * Group files by table.
  *
  * @param {Array} files An array of files.
+ * @returns {Object} An object with grouped files.
  */
 exports.groupJson = files => {
   const result = {};

package/dist/storage/storage.js

@@ -19,9 +19,11 @@ const {
 /**
  * Gets a Google Cloud Storage client with default settings.
  *
+ * @param {string} projectId Optional project ID.
  * @returns {Storage} A Google Cloud Storage client.
  */
-exports.getStorage = () => new Storage({
+exports.getStorage = (projectId = null) => new Storage({
+  projectId,
   retryOptions: {
     autoRetry: true,
     retryDelayMultiplier: 4
@@ -32,7 +34,8 @@ exports.getStorage = () => new Storage({
  * Gets a Google Cloud Storage bucket.
  *
  * @param {string} bucket Bucket name.
+ * @param {string} projectId Optional project ID.
  * @returns {Storage} A Google Cloud Storage client.
  * @since 1.4.0
  */
-exports.getBucket = bucket => exports.getStorage().bucket(bucket);
+exports.getBucket = (bucket, projectId = null) => exports.getStorage(projectId).bucket(bucket);

package/dist/storage/txt.js

@@ -0,0 +1,30 @@
+// Copyright 2024-2026 Pittica S.r.l.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+const {
+  readFile
+} = require("./file");
+
+/**
+ * Converts text content to an array.
+ *
+ * @param {string} file File name and path.
+ * @param {string} bucket Bucket name.
+ * @param {string} projectId Optional project ID.
+ * @returns {Array} File content.
+ */
+exports.txtContentToArray = async (file, bucket, projectId = null) => {
+  const buffer = await readFile(file, bucket, projectId);
+  return buffer.toString().split("\n").filter(line => line.trim() !== "");
+};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@pittica/google-cloud-storage-helpers",
   "private": false,
-  "version": "1.4.0",
+  "version": "1.6.0",
   "description": "Helpers for Google Cloud Storage.",
   "main": "dist/index.js",
   "scripts": {
@@ -26,13 +26,13 @@
   },
   "homepage": "https://github.com/pittica/google-cloud-storage-helpers#README.md",
   "dependencies": {
-    "@google-cloud/storage": "^7.21.0",
-    "@pittica/logger-helpers": "^1.0.5"
+    "@google-cloud/storage": "^8.4.0",
+    "@pittica/logger-helpers": "^1.2.2"
   },
   "devDependencies": {
-    "@babel/cli": "^7.29.7",
+    "@babel/cli": "^8.0.6",
     "mkdirp": "^3.0.1",
-    "prettier": "^3.9.0",
+    "prettier": "^3.9.10",
     "rimraf": "^6.1.3",
     "run-func": "^3.0.0"
   }