@tmlmobilidade/files 20251229.932.45 → 20260103.2047.14

package/dist/files.d.ts

@@ -1,5 +1,5 @@
 import JSZip from 'jszip';
-import { ParseConfig } from 'papaparse';
+import { type ParseConfig } from 'papaparse';
 interface UpdateCsvFieldParams {
     column: string;
     csvString: string;
@@ -8,9 +8,18 @@ interface UpdateCsvFieldParams {
 }
 export declare class Files {
     /**
-     * Blob to JS File
+     * Converts a Blob to a File.
+     * @param blob The Blob object to convert.
+     * @param fileName The name of the resulting File.
+     * @returns The resulting File.
      */
     static blobToFile(blob: Blob, fileName: string): File;
+    /**
+     * Returns the file extension from a file name.
+     * @param fileName The name of the file.
+     * @returns The file extension.
+     * @throws Error if the file has no extension or if the extension is not supported.
+     */
     static getFileExtension(fileName: string): string;
     /**
      * Gets the file extension from a MIME type.
@@ -18,23 +27,28 @@ export declare class Files {
      * @returns The file extension, or an empty string if not found.
      */
     static getFileExtensionFromMimeType(mimeType: string): string;
+    /**
+     * Gets the MIME type from a file extension.
+     * @param fileName The name of the file to get the MIME type for.
+     * @returns The MIME type.
+     */
     static getMimeTypeFromFileExtension(fileName: string): string;
     /**
      * Parses a CSV string into an array of objects using PapaParse.
-     * @param csvString - The CSV string to parse
-     * @param options - Parse configuration options
-     * @param options.header - Whether to interpret first row as field names. Defaults to true.
-     * @param options.skipEmptyLines - Whether to skip empty lines in the CSV. Defaults to true.
-     * @param options.rest - Additional PapaParse configuration options
+     * @param csvString The CSV string to parse
+     * @param options Parse configuration options
+     * @param options.header Whether to interpret first row as field names. Defaults to true.
+     * @param options.skipEmptyLines Whether to skip empty lines in the CSV. Defaults to true.
+     * @param options.rest Additional PapaParse configuration options
      * @returns Promise resolving to array of parsed objects
      * @throws Error if parsing fails with details of parsing errors
      */
     static parseCsv<T>(csvString: string, { header, skipEmptyLines, ...options }: ParseConfig<T>): Promise<T[]>;
     /**
      * Reads and extracts a single file from a ZIP archive.
-     * @param zipFilePath - The ZIP file to read from, can be a File object (browser), string path (Node.js), or URL
-     * @param fileName - The name of the file to extract from the ZIP
-     * @param encoding - The encoding to use when reading the file. See JSZip documentation for supported formats.
+     * @param zipFilePath The zip file to read from, can be a File object (browser), string path (Node.js), or URL
+     * @param fileName The name of the file to extract from the ZIP
+     * @param encoding The encoding to use when reading the file. See JSZip documentation for supported formats.
      * @returns A Promise resolving to the file contents in the specified encoding
      * @throws Error if the file is not found in the ZIP
      */
@@ -47,10 +61,10 @@ export declare class Files {
     static unzip(zipFilePath: File | string | URL): Promise<JSZip>;
     /**
      * Updates a CSV string with an object.
-     * @param csvString - The CSV string to update
-     * @param column - The column name to update
-     * @param row - The row index to update
-     * @param value - The value to update the column with
+     * @param csvString The CSV string to update
+     * @param column The column name to update
+     * @param row The row index to update
+     * @param value The value to update the column with
      * @returns A Promise resolving to the updated CSV string
      */
     static updateCsvField<T>(params: UpdateCsvFieldParams[]): Promise<string>;

package/dist/files.js

@@ -8,20 +8,33 @@ import papaparse from 'papaparse';
 export class Files {
     //
     /**
-     * Blob to JS File
+     * Converts a Blob to a File.
+     * @param blob The Blob object to convert.
+     * @param fileName The name of the resulting File.
+     * @returns The resulting File.
      */
     static blobToFile(blob, fileName) {
         return new File([blob], fileName);
     }
+    /**
+     * Returns the file extension from a file name.
+     * @param fileName The name of the file.
+     * @returns The file extension.
+     * @throws Error if the file has no extension or if the extension is not supported.
+     */
     static getFileExtension(fileName) {
-        const extension = fileName.split('.').pop();
-        if (!extension) {
+        // Extract the file extension from the file name.
+        const extension = fileName.split('.').pop().toLowerCase();
+        // Throw an error if the file has no extension
+        // or if the extension is not supported.
+        if (!extension)
             throw new Error('File has no extension');
-        }
+        // Get the MIME type for the extension.
         const mimeType = mimeTypes[extension];
-        if (!mimeType) {
+        // Throw an error if the extension is not supported.
+        if (!mimeType)
             throw new Error(`Unsupported file extension: ${extension}`);
-        }
+        // Return the file extension.
         return extension;
     }
     /**
@@ -37,17 +50,22 @@ export class Files {
             return '';
         return extension;
     }
+    /**
+     * Gets the MIME type from a file extension.
+     * @param fileName The name of the file to get the MIME type for.
+     * @returns The MIME type.
+     */
     static getMimeTypeFromFileExtension(fileName) {
         const extension = Files.getFileExtension(fileName);
         return mimeTypes[extension];
     }
     /**
      * Parses a CSV string into an array of objects using PapaParse.
-     * @param csvString - The CSV string to parse
-     * @param options - Parse configuration options
-     * @param options.header - Whether to interpret first row as field names. Defaults to true.
-     * @param options.skipEmptyLines - Whether to skip empty lines in the CSV. Defaults to true.
-     * @param options.rest - Additional PapaParse configuration options
+     * @param csvString The CSV string to parse
+     * @param options Parse configuration options
+     * @param options.header Whether to interpret first row as field names. Defaults to true.
+     * @param options.skipEmptyLines Whether to skip empty lines in the CSV. Defaults to true.
+     * @param options.rest Additional PapaParse configuration options
      * @returns Promise resolving to array of parsed objects
      * @throws Error if parsing fails with details of parsing errors
      */
@@ -60,18 +78,17 @@ export class Files {
     }
     /**
      * Reads and extracts a single file from a ZIP archive.
-     * @param zipFilePath - The ZIP file to read from, can be a File object (browser), string path (Node.js), or URL
-     * @param fileName - The name of the file to extract from the ZIP
-     * @param encoding - The encoding to use when reading the file. See JSZip documentation for supported formats.
+     * @param zipFilePath The zip file to read from, can be a File object (browser), string path (Node.js), or URL
+     * @param fileName The name of the file to extract from the ZIP
+     * @param encoding The encoding to use when reading the file. See JSZip documentation for supported formats.
      * @returns A Promise resolving to the file contents in the specified encoding
      * @throws Error if the file is not found in the ZIP
      */
     static async readFileFromZip(zipFilePath, fileName, encoding) {
         const zip = await Files.unzip(zipFilePath);
         const file = zip.file(fileName);
-        if (!file) {
-            throw new Error(`File ${fileName} not found in ZIP`);
-        }
+        if (!file)
+            throw new Error(`File ${fileName} not found in the zip archive.`);
         return await file.async(encoding);
     }
     /**
@@ -112,18 +129,17 @@ export class Files {
     }
     /**
      * Updates a CSV string with an object.
-     * @param csvString - The CSV string to update
-     * @param column - The column name to update
-     * @param row - The row index to update
-     * @param value - The value to update the column with
+     * @param csvString The CSV string to update
+     * @param column The column name to update
+     * @param row The row index to update
+     * @param value The value to update the column with
      * @returns A Promise resolving to the updated CSV string
      */
     static async updateCsvField(params) {
         let csv = params[0].csvString;
         for (const param of params) {
-            const { column, rowIndex, value } = param;
             const data = await this.parseCsv(csv, { header: true });
-            const updatedData = data.map((row, index) => (index === rowIndex ? { ...row, [column]: value } : row));
+            const updatedData = data.map((row, index) => (index === param.rowIndex ? { ...row, [param.column]: param.value } : row));
             csv = papaparse.unparse(updatedData, { header: true });
         }
         return csv;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@tmlmobilidade/files",
-	"version": "20251229.932.45",
+	"version": "20260103.2047.14",
 	"author": {
 		"email": "iso@tmlmobilidade.pt",
 		"name": "TML-ISO"