npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

s3-express-zip

v1.1.0

Published

Download multiple objects from S3 bucket to zip archive through stream

Downloads

347

Readme

S3-Express-Zip

import S3ExpressZip, {getS3ObjectsList, getS3ObjectStream, getHTTPHeaders} from 's3-express-zip';
import {PassThrough} from 'stream';
import https from "https";
import {S3} from 'aws-sdk';

const configS3 = {
    endpoint: 'BUCKET_ENDPOINT',
    region: 'BUCKET_REGION',
    accessKeyId: 'ACCESS_KEY_ID',
    secretAccessKey: 'SECRET_ACCESS_KEY'
};

const s3 = new S3({
    endpoint: 'BUCKET_ENDPOINT',
    accessKeyId: 'ACCESS_KEY_ID',
    secretAccessKey: 'SECRET_ACCESS_KEY',
});

s3.config.update(configS3);
const Bucket = 'BUCKET_NAME';
const Prefix = 'BUCKET_PREFIX';

function cb(error: any, data: any) {
    console.log(
      '-----------------',
      `|ZIP CB ${error ? 'ERROR' : 'SUCCES'}|`,
      error || `${data}o archived`,
      `|END CB ${error ? 'ERROR' : 'SUCCES'}|`,
      '-----------------',
    )
}
/**
  res should be a writable stream
*/
async function downloadFromS3KeepingPrefix(req, res) {
    // Default archive name:
    const archiveName = `archive-${(new Date()).getTime()}.zip`;
    // Retrieving objects from Bucket
    const objects = await getS3ObjectsList(s3, Bucket, Prefix);
    // Getting headers for HTTP Response if needed
    const headers: {[key: string]: string} = getHTTPHeaders(objectsList, archiveName);
    // Setting headers for HTTP Response if needed
    (Object.keys(headers))
      .forEach((headerKey: string) => res.setHeader(headerKey, headers[headerKey]));
  
    // Finally send stream archive to client (or any writable stream)  
    S3ExpressZip({res})(objects.map((f:any) => getS3ObjectStream(s3, f)), cb)
}

/**
  res should be a writable stream
*/
async function downloadFromS3RemovingPrefix(req, res) {
    // Default archive name:
    const archiveName = `archive-${(new Date()).getTime()}.zip`;
    /**
      Retrieving objects from Bucket
      You can remove prefix from filename in archive, or filter the objects..
      If you use the Content-Length property header, 
      you have to remove Prefix from filename before getting httpHeaders
      else, the Content-Length will missmatch and HTTP Request fail
    */
    const objects = (await getS3ObjectsList(s3, Bucket, Prefix))
        .map((obj: any) => ({
            ...obj,
            Name: obj.Key.split(`${Prefix}/`).join('')
        }));
    // Getting headers for HTTP Response if needed
    const headers: {[key: string]: string} = getHTTPHeaders(objectsList, archiveName);
    // Setting headers for HTTP Response if needed
    (Object.keys(headers))
      .forEach((headerKey: string) => res.setHeader(headerKey, headers[headerKey]));

    // Finally send stream archive to client (or any writable stream)
    S3ExpressZip({res})(objects.map((f:any) => getS3ObjectStream(s3, f)), cb)
}