s3-zip 3.2.0 → 3.3.0

package/.travis.yml

@@ -1,5 +1,5 @@
 language: node_js
 node_js:
+  - 18
+  - 16
   - 14
-  - 12
-  - 10

package/README.md

@@ -51,16 +51,16 @@ s3Zip
 You can also pass a custom S3 client. For example if you want to zip files from a S3 compatible storage:
 
 ```javascript
-const aws = require('aws-sdk')
+const { S3Client } = require('@aws-sdk/client-s3')
 
-const s3Client = new aws.S3({
+const S3Client = new aws.S3({
   signatureVersion: 'v4',
   s3ForcePathStyle: 'true',
   endpoint: 'http://localhost:9000',
 })
 
 s3Zip
-  .archive({ s3: s3Client, bucket: bucket }, folder, [file1, file2])
+  .archive({ s3: S3Client, bucket: bucket }, folder, [file1, file2])
   .pipe(output)
 ```
 
@@ -74,14 +74,16 @@ Example of s3-zip in combination with [AWS Lambda](aws_lambda.md).
 ```javascript
 const fs = require('fs')
 const join = require('path').join
-const AWS = require('aws-sdk')
+const {
+  S3Client
+} = require("@aws-sdk/client-s3")
 const s3Zip = require('s3-zip')
 const XmlStream = require('xml-stream')
 
 const region = 'bucket-region'
 const bucket = 'name-of-s3-bucket'
 const folder = 'name-of-bucket-folder/'
-const s3 = new AWS.S3({ region: region })
+const s3 = new S3Client({ region: region })
 const params = {
   Bucket: bucket,
   Prefix: folder
@@ -195,7 +197,7 @@ npm run coverage
 
 
 
-[aws-sdk-url]: http://docs.aws.amazon.com/AWSJavaScriptSDK/guide/node-configuring.html
+[aws-sdk-url]: https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/configuring-the-jssdk.html
 [npm-badge]: https://badge.fury.io/js/s3-zip.svg
 [npm-url]: https://badge.fury.io/js/s3-zip
 [travis-badge]: https://travis-ci.org/orangewise/s3-zip.svg?branch=master

package/aws_lambda.md

@@ -4,7 +4,8 @@
 
 
 ```javascript
-const AWS = require('aws-sdk')
+const { Upload } = require("@aws-sdk/lib-storage");
+const { S3 } = require("@aws-sdk/client-s3");
 const s3Zip = require('s3-zip')
 
 exports.handler = function (event, context) {
@@ -22,8 +23,11 @@ exports.handler = function (event, context) {
 
     const body = s3Zip.archive({ region: region, bucket: bucket}, folder, files)
     const zipParams = { params: { Bucket: bucket, Key: folder + zipFileName } }
-    const zipFile = new AWS.S3(zipParams)
-    zipFile.upload({ Body: body })
+    const zipFile = new S3(zipParams)
+    new Upload({
+      client: zipFile,
+      params: { Body: body }
+    })
       .on('httpUploadProgress', function (evt) { console.log(evt) })
       .send(function (e, r) { 
         if (e) {
@@ -40,7 +44,6 @@ exports.handler = function (event, context) {
     console.log(err)    
     context.fail(err)
   }
-
 }
 
 ```
@@ -48,7 +51,7 @@ exports.handler = function (event, context) {
 ## Invoke the function
 
 ```javascript
-const AWS = require('aws-sdk')
+const { LambdaClient } = require("@aws-sdk/client-lambda");
 
 const region = 'bucket-region'
 const bucket = 'name-of-s3-bucket'
@@ -59,12 +62,10 @@ const file3 = 'Image C.png'
 const file4 = 'Image D.png'
 
 
-AWS.config.update({
-  region: region
+const lambda = new LambdaClient({
+  region
 })
 
-const lambda = new AWS.Lambda()
-
 const files = [file1, file2, file3, file4]
 const payload = JSON.stringify({ 
   'region'     : region,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "s3-zip",
-  "version": "3.2.0",
+  "version": "3.3.0",
   "description": "Download selected files from an Amazon S3 bucket as a zip file.",
   "main": "s3-zip.js",
   "scripts": {
@@ -25,19 +25,19 @@
   },
   "homepage": "https://github.com/orangewise/s3-zip#readme",
   "dependencies": {
-    "archiver": "^5.2.0",
-    "s3-files": "^2.0.0"
+    "archiver": "^6.0.1",
+    "s3-files": "^3.0.0"
   },
   "devDependencies": {
     "archiver-zip-encryptable": "^1.0.5",
     "child_process": "^1.0.2",
     "concat-stream": "^2.0.0",
     "proxyquire": "^2.1.3",
-    "sinon": "^7.4.1",
-    "standard": "^14.0.2",
+    "sinon": "^16.0.0",
+    "standard": "^17.1.0",
     "stream-array": "^1.1.2",
-    "tap": "^14.6.1",
-    "tar": "^4.4.10",
-    "yauzl": "^2.9.1"
+    "tap": "^16.3.8",
+    "tar": "^6.2.0",
+    "yauzl": "^2.10.0"
   }
 }

package/test/test-s3-error-on-stream.js

@@ -1,16 +1,16 @@
-var s3Zip = require('../s3-zip.js')
-var t = require('tap')
-var fs = require('fs')
-var Stream = require('stream')
-var concat = require('concat-stream')
-var join = require('path').join
-var proxyquire = require('proxyquire')
-var sinon = require('sinon')
+let s3Zip = require('../s3-zip.js')
+const t = require('tap')
+const fs = require('fs')
+const Stream = require('stream')
+const concat = require('concat-stream')
+const join = require('path').join
+const proxyquire = require('proxyquire')
+const sinon = require('sinon')
 
-var fileStream = function (file) {
-  var rs = new Stream()
+const fileStream = function (file) {
+  const rs = new Stream()
   rs.readable = true
-  var fileStream = fs.createReadStream(join(__dirname, file))
+  const fileStream = fs.createReadStream(join(__dirname, file))
   fileStream
     .pipe(concat(
       function buffersEmit (buffer) {
@@ -26,18 +26,18 @@ var fileStream = function (file) {
 }
 
 t.test('test if error on filestream with archiveStream', function (child) {
-  var stream = fileStream('./fixtures/file.txt')
-  var files = ['foo.png']
+  const stream = fileStream('./fixtures/file.txt')
+  const files = ['foo.png']
   s3Zip.archiveStream(stream, files)
   child.end()
 })
 
 t.test('test if error on filestream with archive', function (child) {
-  var stream = fileStream('./fixtures/file.txt')
+  const stream = fileStream('./fixtures/file.txt')
   s3Zip = proxyquire('../s3-zip.js', {
     's3-files': { createFileStream: sinon.stub().returns(stream) }
   })
-  var files = ['foo.png']
+  const files = ['foo.png']
   s3Zip.archive({ region: 'region', bucket: 'bucket' }, 'folder', files)
   child.end()
 })

package/test/test-s3-password-protected.js

@@ -1,27 +1,27 @@
-var s3Zip = require('../s3-zip.js')
-var t = require('tap')
-var fs = require('fs')
-var Stream = require('stream')
-var concat = require('concat-stream')
-var join = require('path').join
-var streamify = require('stream-array')
-var archiverZipEncryptable = require('archiver-zip-encryptable')
-var { exec } = require('child_process')
+let s3Zip = require('../s3-zip.js')
+const t = require('tap')
+const fs = require('fs')
+const Stream = require('stream')
+const concat = require('concat-stream')
+const join = require('path').join
+const streamify = require('stream-array')
+const archiverZipEncryptable = require('archiver-zip-encryptable')
+const { exec } = require('child_process')
 
-var fileStreamForFiles = function (files, preserveFolderPath) {
-  var rs = new Stream()
+const fileStreamForFiles = function (files, preserveFolderPath) {
+  const rs = new Stream()
   rs.readable = true
 
-  var fileCounter = 0
+  let fileCounter = 0
   streamify(files).on('data', function (file) {
     fileCounter += 1
 
-    var fileStream = fs.createReadStream(join(__dirname, file))
+    const fileStream = fs.createReadStream(join(__dirname, file))
     fileStream.pipe(
       concat(function buffersEmit (buffer) {
         // console.log('buffers concatenated, emit data for ', file);
-        var path = preserveFolderPath ? file : file.replace(/^.*[\\/]/, '')
-        rs.emit('data', { data: buffer, path: path })
+        const path = preserveFolderPath ? file : file.replace(/^.*[\\/]/, '')
+        rs.emit('data', { data: buffer, path })
       })
     )
     fileStream.on('end', function () {
@@ -35,11 +35,11 @@ var fileStreamForFiles = function (files, preserveFolderPath) {
   return rs
 }
 
-var file1 = 'a/file.txt'
-var file2 = 'b/file.txt'
-var sinon = require('sinon')
-var proxyquire = require('proxyquire')
-var s3Stub = fileStreamForFiles(
+const file1 = 'a/file.txt'
+const file2 = 'b/file.txt'
+const sinon = require('sinon')
+const proxyquire = require('proxyquire')
+const s3Stub = fileStreamForFiles(
   ['/fixtures/folder/a/file.txt', '/fixtures/folder/b/file.txt'],
   true
 )
@@ -48,8 +48,8 @@ s3Zip = proxyquire('../s3-zip.js', {
 })
 
 t.test('test archive password protected', async child => {
-  var outputPath = join(__dirname, '/test-password-protected.zip')
-  var output = fs.createWriteStream(outputPath)
+  const outputPath = join(__dirname, '/test-password-protected.zip')
+  const output = fs.createWriteStream(outputPath)
 
   await s3Zip
     .setRegisterFormatOptions('zip-encryptable', archiverZipEncryptable)

package/test/test-s3-same-file-alt-names.js

@@ -1,28 +1,30 @@
 // Test s3-zip BUT using alternate file names for the same file which is listed multiple times
 
-var s3Zip = require('../s3-zip.js')
-var t = require('tap')
-var fs = require('fs')
-var Stream = require('stream')
-var concat = require('concat-stream')
-var join = require('path').join
-var streamify = require('stream-array')
-var tar = require('tar')
+const s3Zip = require('../s3-zip.js')
+const t = require('tap')
+const fs = require('fs')
+const Stream = require('stream')
+const concat = require('concat-stream')
+const join = require('path').join
+const streamify = require('stream-array')
+const tar = require('tar')
+const sinon = require('sinon')
+const proxyquire = require('proxyquire')
 
-var fileStreamForFiles = function (files, preserveFolderPath) {
-  var rs = new Stream()
+const fileStreamForFiles = function (files, preserveFolderPath) {
+  const rs = new Stream()
   rs.readable = true
 
-  var fileCounter = 0
+  let fileCounter = 0
   streamify(files).on('data', function (file) {
     fileCounter += 1
 
-    var fileStream = fs.createReadStream(join(__dirname, file))
+    const fileStream = fs.createReadStream(join(__dirname, file))
     fileStream.pipe(
       concat(function buffersEmit (buffer) {
         // console.log('buffers concatenated, emit data for ', file);
-        var path = preserveFolderPath ? file : file.replace(/^.*[\\/]/, '')
-        rs.emit('data', { data: buffer, path: path })
+        const path = preserveFolderPath ? file : file.replace(/^.*[\\/]/, '')
+        rs.emit('data', { data: buffer, path })
       })
     )
     fileStream.on('end', function () {
@@ -36,20 +38,20 @@ var fileStreamForFiles = function (files, preserveFolderPath) {
   return rs
 }
 
-var inputFiles = [
-  '/fixtures/folder/a/file.txt',
-  '/fixtures/folder/a/file.txt'
-]
-var outputFiles = [
+const outputFiles = [
   'FILE_1_ALT_1.TXT',
   'FILE_1_ALT_2.TXT'
 ]
-var filesRead = []
+const filesRead = []
 
 t.test('test a tar archive with alternate names for one file listed many times', function (child) {
-  var outputPath = join(__dirname, '/test-same_file_alt_name.tar')
-  var output = fs.createWriteStream(outputPath)
-  var archive = s3Zip
+  const inputFiles = [
+    '/fixtures/folder/a/file.txt',
+    '/fixtures/folder/a/file.txt'
+  ]
+  const outputPath = join(__dirname, '/test-same_file_alt_name.tar')
+  const output = fs.createWriteStream(outputPath)
+  const archive = s3Zip
     .setFormat('tar')
     .archiveStream(fileStreamForFiles(inputFiles, true), inputFiles, outputFiles)
     .pipe(output)
@@ -68,7 +70,14 @@ t.test('test a tar archive with alternate names for one file listed many times',
 })
 
 t.test('test archive with alternate names for one file listed many times', function (child) {
-  var archive = s3Zip
+  const inputFiles = [
+    '/fixtures/folder/a/file.txt',
+    '/fixtures/folder/a/file.txt'
+  ]
+  const s3Zip = proxyquire('../s3-zip.js', {
+    's3-files': { createFileStream: sinon.stub().returns(fileStreamForFiles(inputFiles, true)) }
+  })
+  const archive = s3Zip
     .archive({ region: 'region', bucket: 'bucket' },
       '',
       inputFiles,

package/test/test-s3-zip-alt-names.js

@@ -1,18 +1,18 @@
 // Test s3-zip BUT using alternate file names in the resulting zip archive
 
-var s3Zip = require('../s3-zip.js')
-var t = require('tap')
-var fs = require('fs')
-var Stream = require('stream')
-var concat = require('concat-stream')
-var yauzl = require('yauzl')
-var join = require('path').join
-var tar = require('tar')
+let s3Zip = require('../s3-zip.js')
+const t = require('tap')
+const fs = require('fs')
+const Stream = require('stream')
+const concat = require('concat-stream')
+const yauzl = require('yauzl')
+const join = require('path').join
+const tar = require('tar')
 
-var fileStream = function (file, forceError) {
-  var rs = new Stream()
+const fileStream = function (file, forceError) {
+  const rs = new Stream()
   rs.readable = true
-  var fileStream = fs.createReadStream(join(__dirname, file))
+  const fileStream = fs.createReadStream(join(__dirname, file))
   fileStream
     .pipe(concat(
       function buffersEmit (buffer) {
@@ -32,21 +32,21 @@ var fileStream = function (file, forceError) {
   return rs
 }
 
-var file1 = '/fixtures/file.txt'
-var file1Alt = 'FILE_ALT.TXT'
-var file1DataEntry = { name: file1Alt, mode: parseInt('0600', 8) }
+const file1 = '/fixtures/file.txt'
+const file1Alt = 'FILE_ALT.TXT'
+const file1DataEntry = { name: file1Alt, mode: parseInt('0600', 8) }
 // Stub: var fileStream = s3Files.createFileStream(keyStream);
-var sinon = require('sinon')
-var proxyquire = require('proxyquire')
-var s3Stub = fileStream(file1)
+const sinon = require('sinon')
+const proxyquire = require('proxyquire')
+const s3Stub = fileStream(file1)
 s3Zip = proxyquire('../s3-zip.js', {
   's3-files': { createFileStream: sinon.stub().returns(s3Stub) }
 })
 
 t.test('test archiveStream and zip file with alternate file name in zip archive', function (child) {
-  var output = fs.createWriteStream(join(__dirname, '/test-alt.zip'))
-  var s = fileStream(file1)
-  var archive = s3Zip
+  const output = fs.createWriteStream(join(__dirname, '/test-alt.zip'))
+  const s = fileStream(file1)
+  const archive = s3Zip
     .archiveStream(s, [file1], [file1Alt])
     .pipe(output)
   archive.on('close', function () {
@@ -69,7 +69,7 @@ t.test('test archiveStream and zip file with alternate file name in zip archive'
 })
 
 t.test('test archive with alternate zip archive names', function (child) {
-  var archive = s3Zip
+  const archive = s3Zip
     .archive({ region: 'region', bucket: 'bucket' },
       'folder',
       [file1],
@@ -80,9 +80,9 @@ t.test('test archive with alternate zip archive names', function (child) {
 })
 
 t.test('test a tar archive with EntryData object', function (child) {
-  var outputPath = join(__dirname, '/test-entrydata.tar')
-  var output = fs.createWriteStream(outputPath)
-  var archive = s3Zip
+  const outputPath = join(__dirname, '/test-entrydata.tar')
+  const output = fs.createWriteStream(outputPath)
+  const archive = s3Zip
     .setFormat('tar')
     .archiveStream(fileStream(file1), [file1], [file1DataEntry])
     .pipe(output)

package/test/test-s3-zip-unique-prefix.js

@@ -1,26 +1,26 @@
-var s3Zip = require('../s3-zip.js')
-var t = require('tap')
-var fs = require('fs')
-var Stream = require('stream')
-var concat = require('concat-stream')
-var yauzl = require('yauzl')
-var join = require('path').join
-var streamify = require('stream-array')
+let s3Zip = require('../s3-zip.js')
+const t = require('tap')
+const fs = require('fs')
+const Stream = require('stream')
+const concat = require('concat-stream')
+const yauzl = require('yauzl')
+const join = require('path').join
+const streamify = require('stream-array')
 
-var fileStreamForFiles = function (files, preserveFolderPath) {
-  var rs = new Stream()
+const fileStreamForFiles = function (files, preserveFolderPath) {
+  const rs = new Stream()
   rs.readable = true
 
-  var fileCounter = 0
+  let fileCounter = 0
   streamify(files).on('data', function (file) {
     fileCounter += 1
 
-    var fileStream = fs.createReadStream(join(__dirname, file))
+    const fileStream = fs.createReadStream(join(__dirname, file))
     fileStream.pipe(
       concat(function buffersEmit (buffer) {
         // console.log('buffers concatenated, emit data for ', file);
-        var path = preserveFolderPath ? file : file.replace(/^.*[\\/]/, '')
-        rs.emit('data', { data: buffer, path: path })
+        const path = preserveFolderPath ? file : file.replace(/^.*[\\/]/, '')
+        rs.emit('data', { data: buffer, path })
       })
     )
     fileStream.on('end', function () {
@@ -34,13 +34,13 @@ var fileStreamForFiles = function (files, preserveFolderPath) {
   return rs
 }
 
-var file1 = 'a/file.txt'
-var file1Alt = 'file.txt'
-var file2 = 'b/file.txt'
-var file2Alt = 'file-1.txt'
-var sinon = require('sinon')
-var proxyquire = require('proxyquire')
-var s3Stub = fileStreamForFiles(
+const file1 = 'a/file.txt'
+const file1Alt = 'file.txt'
+const file2 = 'b/file.txt'
+const file2Alt = 'file-1.txt'
+const sinon = require('sinon')
+const proxyquire = require('proxyquire')
+const s3Stub = fileStreamForFiles(
   ['/fixtures/folder/a/file.txt', '/fixtures/folder/b/file.txt'],
   true
 )
@@ -51,10 +51,10 @@ s3Zip = proxyquire('../s3-zip.js', {
 t.test(
   'test archive with matching alternate zip archive names but unique keys',
   function (child) {
-    var outputPath = join(__dirname, '/test-unique.zip')
-    var output = fs.createWriteStream(outputPath)
+    const outputPath = join(__dirname, '/test-unique.zip')
+    const output = fs.createWriteStream(outputPath)
 
-    var archive = s3Zip
+    const archive = s3Zip
       .archive(
         { region: 'region', bucket: 'bucket' },
         '/fixtures/folder/',
@@ -63,13 +63,13 @@ t.test(
       )
       .pipe(output)
 
-    var altFiles = [file1Alt, file2Alt]
+    const altFiles = [file1Alt, file2Alt]
 
     archive.on('close', function () {
       yauzl.open(outputPath, function (err, zip) {
         if (err) console.log('err', err)
         zip.on('entry', function (entry) {
-          var i = altFiles.indexOf(entry.fileName)
+          const i = altFiles.indexOf(entry.fileName)
           if (i > -1) {
             child.same(entry.fileName, altFiles[i])
             altFiles.splice(i, 1)

package/test/test-s3-zip.js

@@ -1,15 +1,15 @@
-var s3Zip = require('../s3-zip.js')
-var t = require('tap')
-var fs = require('fs')
-var Stream = require('stream')
-var concat = require('concat-stream')
-var yauzl = require('yauzl')
-var join = require('path').join
+let s3Zip = require('../s3-zip.js')
+const t = require('tap')
+const fs = require('fs')
+const Stream = require('stream')
+const concat = require('concat-stream')
+const yauzl = require('yauzl')
+const { join } = require('path')
 
-var fileStream = function (file, forceError) {
-  var rs = new Stream()
+const fileStream = function (file, forceError) {
+  const rs = new Stream()
   rs.readable = true
-  var fileStream = fs.createReadStream(join(__dirname, file))
+  const fileStream = fs.createReadStream(join(__dirname, file))
   fileStream.pipe(
     concat(function buffersEmit (buffer) {
       if (forceError) {
@@ -27,20 +27,20 @@ var fileStream = function (file, forceError) {
   return rs
 }
 
-var file1 = '/fixtures/file.txt'
-var emptyFile = '/fixtures/empty.txt'
+const file1 = '/fixtures/file.txt'
+const emptyFile = '/fixtures/empty.txt'
 // Stub: var fileStream = s3Files.createFileStream(keyStream);
-var sinon = require('sinon')
-var proxyquire = require('proxyquire')
-var s3Stub = fileStream(file1)
+const sinon = require('sinon')
+const proxyquire = require('proxyquire')
+const s3Stub = fileStream(file1)
 s3Zip = proxyquire('../s3-zip.js', {
   's3-files': { createFileStream: sinon.stub().returns(s3Stub) }
 })
 
 t.test('test archiveStream and zip file', function (child) {
-  var output = fs.createWriteStream(join(__dirname, '/test.zip'))
-  var s = fileStream(file1)
-  var archive = s3Zip.archiveStream(s).pipe(output)
+  const output = fs.createWriteStream(join(__dirname, '/test.zip'))
+  const s = fileStream(file1)
+  const archive = s3Zip.archiveStream(s).pipe(output)
   archive.on('close', function () {
     console.log('+++++++++++')
     yauzl.open(join(__dirname, '/test.zip'), function (err, zip) {
@@ -61,7 +61,7 @@ t.test('test archiveStream and zip file', function (child) {
 })
 
 t.test('test archive', function (child) {
-  var archive = s3Zip.archive(
+  const archive = s3Zip.archive(
     { region: 'region', bucket: 'bucket' },
     'folder',
     [file1]
@@ -71,9 +71,9 @@ t.test('test archive', function (child) {
 })
 
 t.test('test archive on empty file', function (child) {
-  var output = fs.createWriteStream(join(__dirname, '/test.zip'))
-  var s = fileStream(emptyFile)
-  var archive = s3Zip.archiveStream(s).pipe(output)
+  const output = fs.createWriteStream(join(__dirname, '/test.zip'))
+  const s = fileStream(emptyFile)
+  const archive = s3Zip.archiveStream(s).pipe(output)
   archive.on('close', function () {
     console.log('+++++++++++')
     yauzl.open(join(__dirname, '/test.zip'), function (err, zip) {