Creación de archivos Zip en Node

Los archivos Zip son posiblemente el formato de compresión de datos sin pérdida más utilizado. Convirtiéndolo en un estándar para comprimir cualquier tipo de documento, pudiendo de esta forma tanto almacenar como enviar este en un archivo mucho más pequeño que el original. Lo que permite ahorrar espacio de almacenamiento o ancho de banda. Veamos cómo se pueden crear los archivos Zip en Node con el paquete Adm-Zip.

Instalación del paquete

La instalación del Adm-Zip en un proyecto de Node se puede hacer como es habitual usando el comando npm. En este caso deberemos escribir y ejecutar en la terminal la siguiente línea

npm install adm-zip

En el caso de que trabajemos con TypeScript, también es necesario instalar las definiciones del paquete. Para lo que se debería ejecutar en la terminal el siguiente comando

npm install @types/adm-zip -save-dev

Creación de archivos Zip en Node con Adm-Zip

El trabajo con esta librería es bastante sencillo. Solamente se tiene que importar la clase AdmZip, crear un nuevo objeto al que se le agregaran los archivos que se desee y guardar todo en un Zip. Siendo posible agregar tanto archivos como carpetas locales como crear nuevas a partir de datos en memoria.

Agregar archivos locales al archivo Zip

Para agregar un archivo local al Zip se puede usar el método addLocalFile() o, su versión asíncrona, addLocalFolderAsync(). En ambos casos es necesario indicar la ruta al archivo como primer parámetro y, en el caso de que se desee que esta sea diferente la ruta que tendrá en Zip. Así, para importar un logo se podrá hacer

En Analytics Lane

Consistencia en nombres y orden en TypeScript: la base de un código mantenible aplicado a tslane

zip.addLocalFile('images/logo.png');

Lo que agrega un archivo logo.png en la raíz del Zip. Si se desease que este archivo estuviese en una carpeta logos se podría escribir en su lugar

zip.addLocalFile('images/logo.png', 'logos');

Agregar una carpeta al archivo Zip en Node

En el caso de las carpetas también existen un método síncrono y otro asíncrono: addLocalFolder() y addLocalFolderAsync(). Al igual que antes es necesario indicar como primer parámetro la ruta a la carpeta local. Si no se indica un segundo parámetro todos los archivos de esta carpeta se agregarán a la raíz del Zip. Es necesario indicar un segundo parámetro para que los archivos también se guarden en una carpeta dentro de Zip. Así para agregar todas las imágenes a la carpeta raíz se debería escribir algo tal como

zip.addLocalFolder(‘images’);

Mientras que si lo que se desea es que estas se guarden dentro de la carpeta images se tendrá que implementar algo como lo siguiente

zip.addLocalFolder(‘images’, ‘images’);

Agregar archivos de texto o JSON en el Zip

Otra alternativa interesante es la posibilidad de crear archivos con datos que se tienen en memoria, sin la necesidad de volcar esos a disco primero. Para ello se puede usar el método addFile. Este método tiene como primer parámetro el nombre del archivo en el Zip y como segundo los datos que se desean volcar al archivo en un Buffer. Así, para crear un archivo de texto se puede hacer

zip.addFile('text.txt', Buffer.from(text, 'utf8'));

Mientras que si se desea crear un archivo JSON solamente se tendrá que convertir en texto el objeto que se desee. Algo que se puede conseguir con una línea como la siguiente

zip.addFile('data.json', Buffer.from(JSON.stringify(data), 'utf8'));

Volcado del archivo a disco

Una vez agregado todos los archivos que se desee, solamente se tendrá que volcar a un archivo Zip. Lo que puede conseguir con el método writeZip(), al que se le debe pasar como primer parámetro en nombre del archivo.

zip.writeZip('data.zip');

Lo que creará un archivo data.zip con los datos en la ruta actual.

A modo de ejemplo se puede crear un archivo Zip en Node con un código como el que se muestra a continuación.

import AdmZip from "adm-zip";

// Datos de ejemplo
const text = 'Creación de un archivo de Zip con Node';
const data = {'a':1, 'b':2, 'c':3, 'd':4, 'e':5, 'f':6};

// Creación de un archivo de Zip
const zip = new AdmZip();

// Agregar archivos locales
zip.addLocalFile('images/logo.png', 'logos');
zip.addLocalFolder('images', 'images');

// Crear archivos con los datos de ejemplo
zip.addFile('text.txt', Buffer.from(text, 'utf8'));
zip.addFile('data.json', Buffer.from(JSON.stringify(data), 'utf8'));

// Guardar en disco los datos
zip.writeZip('data.zip');

Leer los datos de un archivo Zip en Node

Finalmente, también es posible leer importar los datos de un archivo Zip con esta librería. Para ello solamente se tiene que crear un objeto y posteriormente leer los datos. En el caso de archivos de texto, como puede ser el caso de los JSON, se puede usar el método readAsText(). El que devolverá una cadena de texto con el contenido del archivo. Así para leer el JSON que se creó en la sección anterior solamente se tiene que escribir un programa como el siguiente.

import AdmZip from "adm-zip";

const zip = new AdmZip('data.zip');

const txt =zip.readAsText('data.json');
const data = JSON.parse(txt);

console.log(data);

Conclusiones

En esta entrada se han visto algunas de las opciones que ofrece el paquete Adm-Zip para la creación de archivos Zip en Node. Un paquete que puede ser de gran ayuda para trabajar con archivos Zip en Node.

Imagen de Oliver Menyhart en Pixabay