@beauraines/node-helpers 4.0.39 → 4.1.1

package/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 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.
 
+### [4.1.1](https://github.com/beauraines/node-helpers/compare/v4.1.0...v4.1.1) (2024-10-05)
+
+## [4.1.0](https://github.com/beauraines/node-helpers/compare/v4.0.39...v4.1.0) (2024-10-05)
+
+
+### Features
+
+* **Azure Storage and helpers:** getBinaryBlob and decompress gzip files functions ([#147](https://github.com/beauraines/node-helpers/issues/147)) ([ec156af](https://github.com/beauraines/node-helpers/commit/ec156afb043a70e8f78beb7d276e35b643ab6668)), closes [#146](https://github.com/beauraines/node-helpers/issues/146)
+
 ### [4.0.39](https://github.com/beauraines/node-helpers/compare/v4.0.38...v4.0.39) (2024-10-05)
 
 ### [4.0.38](https://github.com/beauraines/node-helpers/compare/v4.0.37...v4.0.38) (2024-09-29)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@beauraines/node-helpers",
-  "version": "4.0.39",
+  "version": "4.1.1",
   "description": "Collection of node helpers",
   "main": "index.js",
   "repository": {
@@ -21,6 +21,7 @@
     "@azure/storage-queue": "^12.11.0",
     "azure-devops-node-api": "^14.0.1",
     "dayjs": "^1.11.7",
+    "gunzip-maybe": "^1.4.2",
     "node-fetch": "^2.6.7",
     "sparkly": "^5.0.0",
     "sqlite": "^5.0.1",

package/src/azure.js

@@ -210,8 +210,7 @@ getStorageQueueSignedURL(queueUrl,options) {
 
   /**
    * Gets a blob and returns the content. The idea is that you can get a blob without 
-   * having to save it to a file and then re-read it. This may be limited in that it 
-   * can only deal with non-binary content.
+   * having to save it to a file and then re-read it. This cannot handle binary data
    * 
    * @param {string} containerName the container to get the blob from
    * @param {string} blobName the name of the blob to get
@@ -236,6 +235,30 @@ getStorageQueueSignedURL(queueUrl,options) {
 
   }
 
+
+  /**
+   * Gets a blob and returns the content as a Buffer.
+   * 
+   * @param {string} containerName the container to get the blob from
+   * @param {string} blobName the name of the blob to get
+   * @returns {Buffer} the downloaded blob as 
+   */
+  async getBinaryBlob(containerName,blobName) {
+    const blobServiceClient = new BlobServiceClient(
+      this.host('blob',this.cloudName),
+      new StorageSharedKeyCredential(this.storageAccountName, this.storageAccountKey)
+    );
+    const containerClient = blobServiceClient.getContainerClient(containerName);
+    const blobClient = containerClient.getBlobClient(blobName);
+
+     // Get blob content from position 0 to the end
+    // In Node.js, get downloaded data by accessing downloadBlockBlobResponse.readableStreamBody
+    const downloadBlockBlobResponse = await blobClient.download();
+    const downloaded = await streamToBuffer(downloadBlockBlobResponse.readableStreamBody);
+    return downloaded
+
+  }
+
   /**
    * Lists the blobs in a specified container, returning an array of the BlobItem object
    * 

package/src/helpers.js

@@ -1,5 +1,6 @@
 const fs = require('fs');
 const sparkly = require('sparkly')
+const gunzip = require('gunzip-maybe');
 
 /**
  * Converts a string to Title Case, using whitespace as the delimiter
@@ -105,6 +106,7 @@ function getEpochMillis() {
   return Date.now()
 }
 
+
 // TODO Add unit test
 // Expected output last 30 days [1,5] ▁▂▄▆█ 5 from [1,2,3,4,5]
 /**
@@ -128,6 +130,8 @@ function sparkline(data,label,options) {
   // coerces the minimum value to zero because the mimimum option is only used for range validation, 
   // not display https://github.com/sindresorhus/sparkly/blob/9e33eaff891c41e8fb8c8883f62e9821729a9882/index.js#L15
   // sparkly(open,{minimum:27,maximum:50})
+
+  // TODO add option to not display labels issue #148
   return `${label} [${minValue},${maxValue}] ${sparkly(data.map( x=> x- minValue))} ${lastValue}`
 }
 
@@ -165,17 +169,24 @@ async function streamToBuffer(readableStream) {
   });
 }
 
+// Function to decompress a gzipped file and return a stream
+const decompressFile = (filePath) => {
+  return fs.createReadStream(filePath).pipe(gunzip());
+};
+
+
 module.exports = {
-    getEpochMillis,
-    getResourceId,
-    fileExists,
-    groupAndSum,
-    readFile,
-    listFiles,
-    sparkline,
-    streamToBuffer,
-    stripNewLines,
-    toTitleCase,
-    unixTimestamp,
-    writeFile
+  decompressFile,
+  getEpochMillis,
+  getResourceId,
+  fileExists,
+  groupAndSum,
+  readFile,
+  listFiles,
+  sparkline,
+  streamToBuffer,
+  stripNewLines,
+  toTitleCase,
+  unixTimestamp,
+  writeFile
 }