Support typescript

[alalialisiong]

Archiver supports typescript with @types/archiver , but this plugin doesn't seem to support typescript.

[ypicard]

At the moment, I use the following in my project's types/archiver.d.ts:

import 'archiver';

// add typescript support for archiver-zip-encrypted
// https://github.com/artem-karpenko/archiver-zip-encrypted
declare module 'archiver' {
    interface CoreOptions {
        encryptionMethod: 'aes256' | 'zip20' | undefined;
        password: string | undefined;
    }
}

[zeeh1975]

At the moment, I use the following in my project's types/archiver.d.ts:

import 'archiver';

// add typescript support for archiver-zip-encrypted
// https://github.com/artem-karpenko/archiver-zip-encrypted
declare module 'archiver' {
    interface CoreOptions {
        encryptionMethod: 'aes256' | 'zip20' | undefined;
        password: string | undefined;
    }
}

Any way of doing this without lossing existing CoreOptions?

[zeeh1975]

import 'archiver';

// add typescript support for archiver-zip-encrypted
// https://github.com/artem-karpenko/archiver-zip-encrypted
declare module 'archiver' {
interface CoreOptions {
encryptionMethod: 'aes256' | 'zip20' | undefined;
password: string | undefined;
}
}

Making them optionals do the trick

import 'archiver';

// add typescript support for archiver-zip-encrypted
// https://github.com/artem-karpenko/archiver-zip-encrypted
declare module 'archiver' {
interface CoreOptions {
encryptionMethod?: 'aes256' | 'zip20' | undefined;
password?: string | undefined;
}
}

[aestcar]

Hello, can you give me an example of how to use it? Thank you very much

[zeeh1975]

Hello, can you give me an example of how to use it? Thank you very much

About the file you should put it anywhere inside your proyect, in particular I put it in source/types
You can name it as you want but the extension should be .d.ts
Then you can use zip-encrypted when you create an archive:

const compressionLevel = 5;
const encryptionMethod = ZipEncryptionMethod.ZIP20;
let archive: archiver.Archiver;
if (password !== "") { // you cannot use zip-encrypted without a password
            archive = archiver.create("zip-encrypted", { zlib: { level: compressionLevel }, encryptionMethod: encryptionMethod, password: password });
        } else {
            archive = archiver.create("zip", { zlib: { level: compressionLevel } });
        }

[tobi-reap]

A not so elegant solution on my end but it works:

Edit: This doesn't use the one above with .d.ts customization if you want to skip that kind of workaround.

import archiver, { ArchiverOptions } from 'archiver';

archiver.registerFormat('zip-encrypted', require('archiver-zip-encrypted'));

public createZippedBufferWithPassword(data: string, filename: string, password: string): Promise<Buffer> {
  return new Promise((resolve, reject) => {
    const archive = archiver.create('zip-encrypted', {
      zlib: { level: 5 },
      encryptionMethod: 'aes256',
      password,
    } as unknown as ArchiverOptions);
    const buffers: Buffer[] = [];

    archive.on('data', (buffer: Buffer) => buffers.push(buffer));
    archive.on('end', () => resolve(Buffer.concat(buffers)));
    archive.on('error', (err: Error) => reject(err));

    archive.append(data, { name: filename });
    archive.finalize();
  });
}