@tmlmobilidade/go-utils-exec 20260905.126.6 → 20260905.1222.34

package/dist/files/get-zip-file-hash.js

@@ -16,46 +16,55 @@ import { getDirectoryFiles } from './get-directory-files.js';
 export async function getZipFileHash(filePath) {
     //
     //
-    // Initialize a new temporary directory and extract the ZIP file into it.
+    // Initialize a new temporary directory
     const temporaryDirectory = fs.mkdtempDisposableSync('get-zip-file-hash-');
-    await fs
-        .createReadStream(filePath)
-        .pipe(unzipper.Extract({ path: temporaryDirectory.path }))
-        .promise();
-    //
-    // Find all extracted files.
-    const sortedExtractedFilePaths = await getDirectoryFiles(temporaryDirectory.path);
-    //
-    // Initialize the list of files to hash.
-    const foundFiles = [];
-    for (const absolutePath of sortedExtractedFilePaths) {
-        // Create a new hash for the file
-        const hash = createHash('sha256');
-        // Open a read stream for the file.
-        const stream = fs.createReadStream(absolutePath);
-        // Stream the file contents and calculate the SHA-256 hash.
-        for await (const chunk of stream) {
-            hash.update(chunk);
+    try {
+        //
+        //
+        // Extract the ZIP file into the temporary directory.
+        await fs
+            .createReadStream(filePath)
+            .pipe(unzipper.Extract({ path: temporaryDirectory.path }))
+            .promise();
+        //
+        // Find all extracted files.
+        const sortedExtractedFilePaths = await getDirectoryFiles(temporaryDirectory.path);
+        //
+        // Initialize the list of files to hash.
+        const foundFiles = [];
+        for (const absolutePath of sortedExtractedFilePaths) {
+            // Create a new hash for the file
+            const hash = createHash('sha256');
+            // Open a read stream for the file.
+            const stream = fs.createReadStream(absolutePath);
+            // Stream the file contents and calculate the SHA-256 hash.
+            for await (const chunk of stream) {
+                hash.update(chunk);
+            }
+            // Add the file to the list of files to hash.
+            const relativeFilePath = path.relative(temporaryDirectory.path, absolutePath);
+            foundFiles.push({ hash: hash.digest('hex'), path: relativeFilePath });
+        }
+        //
+        // Make the result independent of the order of entries in the zip file.
+        foundFiles.sort((a, b) => a.path.localeCompare(b.path));
+        //
+        // Clean up the temporary directory.
+        temporaryDirectory.remove();
+        //
+        // Calculate the final hash by concatenating the sorted list
+        // of filenames and individual file hashes.
+        const finalHash = createHash('sha256');
+        for (const file of foundFiles) {
+            finalHash.update(file.path);
+            finalHash.update('\0');
+            finalHash.update(file.hash);
+            finalHash.update('\0');
         }
-        // Add the file to the list of files to hash.
-        const relativeFilePath = path.relative(temporaryDirectory.path, absolutePath);
-        foundFiles.push({ hash: hash.digest('hex'), path: relativeFilePath });
+        return finalHash.digest('hex');
+        //
     }
-    //
-    // Make the result independent of the order of entries in the zip file.
-    foundFiles.sort((a, b) => a.path.localeCompare(b.path));
-    //
-    // Clean up the temporary directory.
-    temporaryDirectory.remove();
-    //
-    // Calculate the final hash by concatenating the sorted list
-    // of filenames and individual file hashes.
-    const finalHash = createHash('sha256');
-    for (const file of foundFiles) {
-        finalHash.update(file.path);
-        finalHash.update('\0');
-        finalHash.update(file.hash);
-        finalHash.update('\0');
+    finally {
+        temporaryDirectory.remove();
     }
-    return finalHash.digest('hex');
 }

package/dist/files/stream-csv-file.js

@@ -8,6 +8,13 @@ import fs from 'fs';
  * @returns A promise that resolves when the stream is closed.
  */
 export async function streamCsvFile(filePath, rowParser) {
+    //
+    //
+    // Check if the file exists,
+    // throw an error if it doesn't.
+    await fs.promises.access(filePath);
+    //
+    // Initialize the CSV parser.
     const parser = csvParser({
         bom: true,
         cast: value => value === '' ? undefined : value,
@@ -17,6 +24,9 @@ export async function streamCsvFile(filePath, rowParser) {
         skipRecordsWithEmptyValues: true,
         trim: true,
     });
+    //
+    // Open the file stream and pipe it to the parser,
+    // calling the row parser for each row.
     const fileStream = fs.createReadStream(filePath);
     const stream = fileStream.pipe(parser);
     for await (const rowData of stream) {

package/dist/lifecycle/index.d.ts

@@ -1,2 +1,3 @@
 export * from './run-on-interval.js';
 export * from './run-with-concurrency.js';
+export * from './start-heartbeat.js';

package/dist/lifecycle/index.js

@@ -1,2 +1,3 @@
 export * from './run-on-interval.js';
 export * from './run-with-concurrency.js';
+export * from './start-heartbeat.js';

package/dist/lifecycle/start-heartbeat.d.ts

@@ -0,0 +1,14 @@
+interface StartHeartbeatParams {
+    intervalMs: number;
+    runFn: () => Promise<void>;
+}
+interface StartHeartbeatReturnType {
+    stop: () => void;
+}
+/**
+ * Starts a heartbeat to indicate that an operation is still being processed.
+ * @param operationId The ID of the operation to heartbeat.
+ * @returns An object with a `stop` method to stop the heartbeat.
+ */
+export declare function startHeartbeat({ intervalMs, runFn }: StartHeartbeatParams): StartHeartbeatReturnType;
+export {};

package/dist/lifecycle/start-heartbeat.js

@@ -0,0 +1,33 @@
+/* * */
+/**
+ * Starts a heartbeat to indicate that an operation is still being processed.
+ * @param operationId The ID of the operation to heartbeat.
+ * @returns An object with a `stop` method to stop the heartbeat.
+ */
+export function startHeartbeat({ intervalMs, runFn }) {
+    //
+    let isStopped = false;
+    let timer;
+    const tick = async () => {
+        // Skip if the heartbeat is stopped
+        if (isStopped)
+            return;
+        // Run the function
+        await runFn();
+        // Schedule the next heartbeat
+        if (!isStopped)
+            timer = setTimeout(tick, intervalMs);
+    };
+    //
+    // Start the heartbeat
+    void tick();
+    //
+    // Return the stop function
+    return {
+        stop: () => {
+            isStopped = true;
+            if (timer)
+                clearTimeout(timer);
+        },
+    };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@tmlmobilidade/go-utils-exec",
-	"version": "20260905.126.6",
+	"version": "20260905.1222.34",
 	"author": {
 		"email": "iso@tmlmobilidade.pt",
 		"name": "TML-ISO"