@pittica/google-cloud-storage-helpers 1.0.0 → 1.2.0

package/README.md

@@ -15,7 +15,7 @@ This project uses [Cloud Storage](https://cloud.google.com/storage/docs) librari
 
 This project is licensed.
 
-Copyright 2024 **Pittica S.r.l.**.
+Copyright 2024-2025 **Pittica S.r.l.**.
 
 - [pittica.com](https://pittica.com)
 - [info@pittica.com](mailto:info@pittica.com)

package/dist/index.js

@@ -1,4 +1,4 @@
-// Copyright 2024 Pittica S.r.l.
+// Copyright 2024-2025 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.
@@ -15,20 +15,30 @@
 const {
   copyFile,
   deleteFile,
-  moveFiles
+  moveFiles,
+  getFiles,
+  copiedFile
 } = require("./storage/file");
 const {
-  bucket,
-  file,
-  folder
+  downloadBucket,
+  downloadFile,
+  downloadFolder
 } = require("./storage/download");
 const {
-  write
+  writeJson,
+  groupJson
 } = require("./storage/json");
+const {
+  getStorage
+} = require("./storage/storage");
 exports.copyFile = copyFile;
 exports.deleteFile = deleteFile;
 exports.moveFiles = moveFiles;
-exports.downloadFile = file;
-exports.downloadBucket = bucket;
-exports.downloadFolder = folder;
-exports.writeJson = write;
+exports.getFiles = getFiles;
+exports.copiedFile = copiedFile;
+exports.writeJson = writeJson;
+exports.groupJson = groupJson;
+exports.downloadFile = downloadFile;
+exports.downloadBucket = downloadBucket;
+exports.downloadFolder = downloadFolder;
+exports.getStorage = getStorage;

package/dist/scripts.js

@@ -1,4 +1,4 @@
-// Copyright 2024 Pittica S.r.l.
+// Copyright 2024-2025 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.

package/dist/storage/download.js

@@ -1,4 +1,4 @@
-// Copyright 2024 Pittica S.r.l.
+// Copyright 2024-2025 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.
@@ -26,13 +26,13 @@ const fs = require("fs");
  * @param {string} bucket Bucket name.
  * @param {string} destination Destination path.
  */
-exports.bucket = async (bucket, destination = __dirname) => {
+exports.downloadBucket = async (bucket, destination = __dirname) => {
   const storage = new Storage();
   const source = storage.bucket(bucket);
   const [files] = await source.getFiles();
   files.forEach(({
     name
-  }) => this.file(name, source, destination));
+  }) => this.downloadFile(name, source, destination));
 };
 
 /**
@@ -42,7 +42,7 @@ exports.bucket = async (bucket, destination = __dirname) => {
  * @param {Bucket} bucket Google Cloud Storage bucket object.
  * @param {string} directory Destination directory.
  */
-exports.file = async (file, bucket, directory = __dirname) => {
+exports.downloadFile = async (file, bucket, directory = __dirname) => {
   const destination = path.join(directory, file);
   const folder = path.dirname(destination);
   if (!fs.existsSync(folder)) {
@@ -62,7 +62,7 @@ exports.file = async (file, bucket, directory = __dirname) => {
  *
  * @returns {Promise}
  */
-exports.folder = (folder, bucket, directory = __dirname) => {
+exports.downloadFolder = (folder, bucket, directory = __dirname) => {
   const storage = new Storage();
   const manager = new TransferManager(storage.bucket(bucket));
   const destination = path.join(directory, folder);

package/dist/storage/file.js

@@ -1,4 +1,4 @@
-// Copyright 2024 Pittica S.r.l.
+// Copyright 2024-2025 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.
@@ -59,4 +59,29 @@ exports.copyFile = (source, destination) => source.copy(source.storage.bucket(de
 exports.deleteFile = file => file.delete().then(response => {
   const [res] = response;
   return res.statusCode >= 200 && res.statusCode < 300;
-}).catch(() => false);
+}).catch(() => false);
+
+/**
+ * Gets the files from the given bucket.
+ *
+ * @param {Storage} storage Google Cloud Storage object.
+ * @param {string} bucket Bucket name.
+ * @param {string} prefix Files prefix.
+ * @returns {Array} Files from the given bucket.
+ */
+exports.getFiles = (storage, source, prefix) => storage.bucket(source).getFiles({
+  prefix
+}).then(files => files).catch(() => []);
+
+/**
+ * Process the response from copy API and extracts the response file object.
+ *
+ * @param {Array} response Response.
+ * @returns {File} File object or a null value.
+ */
+exports.copiedFile = response => {
+  if (typeof response[1] !== "undefined" && response[1].done) {
+    return response[0];
+  }
+  return null;
+};

package/dist/storage/json.js

@@ -1,4 +1,4 @@
-// Copyright 2024 Pittica S.r.l.
+// Copyright 2024-2025 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.
@@ -25,7 +25,7 @@ const log = require("@pittica/logger-helpers");
  *
  * @returns {boolean} Write action response.
  */
-exports.write = async (file, body, bucket) => {
+exports.writeJson = async (file, body, bucket) => {
   const storage = new Storage();
   const stream = storage.bucket(bucket).file(file).createWriteStream({
     metadata: {
@@ -36,4 +36,25 @@ exports.write = async (file, body, bucket) => {
   stream.on("finish", () => log.success(`"${file}" has been written.`));
   const buffer = Buffer.from(JSON.stringify(body));
   return stream.end(buffer);
+};
+
+/**
+ * Group files by table.
+ *
+ * @param {Array} files An array of files.
+ */
+exports.groupJson = files => {
+  const result = {};
+  files.forEach(file => {
+    if (file.endsWith(".json")) {
+      const group = file.split(/^(.*)\-[\d]+\.json$/gis);
+      if (group.length > 1) {
+        if (typeof result[group[1]] === "undefined") {
+          result[group[1]] = [];
+        }
+        result[group[1]].push(file);
+      }
+    }
+  });
+  return result;
 };

package/dist/storage/storage.js

@@ -0,0 +1,29 @@
+// Copyright 2024-2025 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 {
+  Storage
+} = require("@google-cloud/storage");
+
+/**
+ * Gets a Google Cloud Storage client with default settings.
+ *
+ * @returns {Storage} A Google Cloud Storage client.
+ */
+exports.getStorage = () => new Storage({
+  retryOptions: {
+    autoRetry: true,
+    retryDelayMultiplier: 4
+  }
+});

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@pittica/google-cloud-storage-helpers",
   "private": false,
-  "version": "1.0.0",
+  "version": "1.2.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.14.0",
+    "@google-cloud/storage": "^7.15.2",
     "@pittica/logger-helpers": "^0.9.0"
   },
   "devDependencies": {
-    "@babel/cli": "^7.25.9",
+    "@babel/cli": "^7.26.4",
     "mkdirp": "^3.0.1",
-    "prettier": "^3.3.3",
+    "prettier": "^3.5.3",
     "rimraf": "^6.0.1",
     "run-func": "^3.0.0"
   }